com.beowulfchain.beowulfj.protocol.operations

Class TransferToVestingOperation

java.lang.Object

com.beowulfchain.beowulfj.protocol.operations.BaseOperation

com.beowulfchain.beowulfj.protocol.operations.Operation

com.beowulfchain.beowulfj.protocol.operations.TransferToVestingOperation

All Implemented Interfaces:

ByteTransformable, Validatable

public class TransferToVestingOperation
extends Operation

This class represents the Beowulf "transfer_to_vesting_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
TransferToVestingOperation(AccountName from, AccountName to, Asset amount, Asset fee) Create a new transfer to vesting operation to transfer Beowulf Power to other users.
TransferToVestingOperation(AccountName from, Asset amount, Asset fee) Like TransferToVestingOperation(AccountName, AccountName, Asset, Asset), but will transform the asset from the from account to the from account.

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.
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	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

TransferToVestingOperation

public TransferToVestingOperation(AccountName from,
                                  AccountName to,
                                  Asset amount,
                                  Asset fee)

Create a new transfer to vesting operation to transfer Beowulf Power to other users.

This operation converts BWF into VFS (Vesting Fund Shares) at the current exchange rate. With this operation it is possible to give another account vesting shares so that faucets can pre-fund new accounts with vesting shares.

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.

Throws:

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

TransferToVestingOperation

public TransferToVestingOperation(AccountName from,
                                  Asset amount,
                                  Asset fee)

Like TransferToVestingOperation(AccountName, AccountName, Asset, Asset), but will transform the asset from the from account to the from account.

Parameters:

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

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

fee - The fee of transaction.

Throws:

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

Method Detail

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.

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, not of symbol type BWF or less than 1.

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.

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.