com.beowulfchain.beowulfj.protocol.operations

Class TransferOperation

java.lang.Object

com.beowulfchain.beowulfj.protocol.operations.BaseOperation

com.beowulfchain.beowulfj.protocol.operations.Operation

com.beowulfchain.beowulfj.protocol.operations.TransferOperation

All Implemented Interfaces:

ByteTransformable, Validatable

public class TransferOperation
extends Operation

This class represents the Beowulf "transfer_operation" object.

Field Summary

Fields

Modifier and Type	Field and Description
protected Asset	amount
protected AccountName	from
protected AccountName	to

Constructor Summary

Constructors

Constructor and Description
TransferOperation(AccountName from, AccountName to, Asset amount, Asset fee, String memo) Create a new transfer operation.Use this operation to transfer an asset from one account to another.

Method Summary

Modifier and Type	Method and Description
Asset	getAmount() Get the amount of that has been send.
Asset	getFee()
AccountName	getFrom() Get the account name of the user who transfered the amount.
String	getMemo() Get the message added to this operation.
Map<SignatureObject,PrivateKeyType>	getRequiredAuthorities(Map<SignatureObject,PrivateKeyType> requiredAuthoritiesBase) Add the authorities which are required to sign this operation to an existing map.
AccountName	getTo() Get the account name of the user who received the amount.
void	setAmount(Asset amount) Set the amount of that will be send.
void	setFee(Asset fee)
void	setFrom(AccountName from) Set the account name of the user who transfers the amount.
void	setMemo(String memo) Add an additional message to this operation.
void	setTo(AccountName to) Set the account name of the user who will received the amount.
byte[]	toByteArray() Covert the operation into a byte array.
String	toString()
void	validate(ValidationType validationType) Use this method to verify that this object is valid.

Methods inherited from class com.beowulfchain.beowulfj.protocol.operations.Operation

isVirtual, mergeRequiredAuthorities, mergeRequiredAuthorities

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

from

protected AccountName from

to

protected AccountName to

amount

protected Asset amount

Constructor Detail

TransferOperation

public TransferOperation(AccountName from,
                         AccountName to,
                         Asset amount,
                         Asset fee,
                         String memo)

Create a new transfer operation.Use this operation to transfer an asset from one account to another.

Parameters:

from - The account to transfer the vestings from (see setFrom(AccountName)).

to - The account that will receive the transfered vestings (see setTo(AccountName)).

amount - The amount of vests to transfer (see setAmount(Asset)).

fee - The fee of transaction.

memo - An additional message added to the operation (see setMemo(String)).

Throws:

InvalidParameterException - If one of the arguments does not fulfill the requirements.

Method Detail

setAmount

public void setAmount(Asset amount)

Set the amount of that will be send.

Parameters:

amount - The amount of that will be send.

Throws:

InvalidParameterException - If the amount is null, of symbol type M or less than 1.

getMemo

public String getMemo()

Get the message added to this operation.

Returns:

The message added to this operation.

setMemo

public void setMemo(String memo)

Add an additional message to this operation.

Parameters:

memo - The message added to this operation.

Throws:

InvalidParameterException - If the memo has more than 2048 characters.

toByteArray

public byte[] toByteArray()
                   throws BeowulfInvalidTransactionException

Description copied from interface: ByteTransformable

Covert the operation into a byte array.

Returns:

The operation as a byte array.

Throws:

BeowulfInvalidTransactionException - If there was a problem while transforming the transaction into a byte array.

toString

public String toString()

Overrides:

toString in class Operation

validate

public void validate(ValidationType validationType)

Description copied from interface: Validatable

Use this method to verify that this object is valid.

Specified by:

validate in interface Validatable

Parameters:

validationType - An indicator telling the method what should be validated.

getFrom

public AccountName getFrom()

Get the account name of the user who transfered the amount.

Returns:

The user which transfered the amount.

setFrom

public void setFrom(AccountName from)

Set the account name of the user who transfers the amount. Notice: The private active key of this account needs to be stored in the key storage.

Parameters:

from - The account name of the user who will transfer the amount.

Throws:

InvalidParameterException - If the from account is null.

getTo

public AccountName getTo()

Get the account name of the user who received the amount.

Returns:

The account name of the user who received the amount.

setTo

public void setTo(AccountName to)

Set the account name of the user who will received the amount.

Parameters:

to - The account name of the user who will received the amount.

Throws:

InvalidParameterException - If the to account is null.

getAmount

public Asset getAmount()

Get the amount of that has been send.

Returns:

The amount of that has been send.

getFee

public Asset getFee()

setFee

public void setFee(Asset fee)

getRequiredAuthorities

public Map<SignatureObject,PrivateKeyType> getRequiredAuthorities(Map<SignatureObject,PrivateKeyType> requiredAuthoritiesBase)

Description copied from class: Operation

Add the authorities which are required to sign this operation to an existing map.

Specified by:

getRequiredAuthorities in class Operation

Parameters:

requiredAuthoritiesBase - A map to which the required authorities of this operation should be added to.

Returns:

A map of required authorities.