Module com.hedera.hashgraph.sdk

Package com.hedera.hashgraph.sdk.proto

Class GrantedTokenAllowance.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder<GrantedTokenAllowance,GrantedTokenAllowance.Builder>

com.google.protobuf.GeneratedMessageLite.Builder<GrantedTokenAllowance,GrantedTokenAllowance.Builder>

com.hedera.hashgraph.sdk.proto.GrantedTokenAllowance.Builder

All Implemented Interfaces:

com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, GrantedTokenAllowanceOrBuilder, Cloneable

Enclosing class:

GrantedTokenAllowance

public static final class GrantedTokenAllowance.Builder
extends com.google.protobuf.GeneratedMessageLite.Builder<GrantedTokenAllowance,GrantedTokenAllowance.Builder>
implements GrantedTokenAllowanceOrBuilder

 *
 Permission granted by one account (the "funding" account) to another
 account (the "spender" account) that allows the spender to spend a
 specified amount of a specific non-HBAR fungible token from the
 balance owned by the funding account.

 An allowance SHALL NOT transfer any tokens directly, it only permits
 transactions signed only by the spender account to transfer tokens
 of the specified type, up to the amount specified, from the funding account.

 Once the specified amount is spent, the allowance SHALL be consumed
 and a new allowance SHALL be required before that spending account
 may spend additional tokens from the funding account.
 

Protobuf type proto.GrantedTokenAllowance

Field Summary

Fields inherited from class com.google.protobuf.GeneratedMessageLite.Builder

instance

Method Summary

Modifier and Type	Method	Description
GrantedTokenAllowance.Builder	clearAmount()	The maximum amount that the spender account may transfer within the scope of this allowance.
GrantedTokenAllowance.Builder	clearSpender()	* The identifier for the spending account associated with this allowance.
GrantedTokenAllowance.Builder	clearTokenId()	* The identifier for the token associated with this allowance.
long	getAmount()	The maximum amount that the spender account may transfer within the scope of this allowance.
AccountID	getSpender()	* The identifier for the spending account associated with this allowance.
TokenID	getTokenId()	* The identifier for the token associated with this allowance.
boolean	hasSpender()	* The identifier for the spending account associated with this allowance.
boolean	hasTokenId()	* The identifier for the token associated with this allowance.
GrantedTokenAllowance.Builder	mergeSpender(AccountID value)	* The identifier for the spending account associated with this allowance.
GrantedTokenAllowance.Builder	mergeTokenId(TokenID value)	* The identifier for the token associated with this allowance.
GrantedTokenAllowance.Builder	setAmount(long value)	The maximum amount that the spender account may transfer within the scope of this allowance.
GrantedTokenAllowance.Builder	setSpender(AccountID value)	* The identifier for the spending account associated with this allowance.
GrantedTokenAllowance.Builder	setSpender(AccountID.Builder builderForValue)	* The identifier for the spending account associated with this allowance.
GrantedTokenAllowance.Builder	setTokenId(TokenID value)	* The identifier for the token associated with this allowance.
GrantedTokenAllowance.Builder	setTokenId(TokenID.Builder builderForValue)	* The identifier for the token associated with this allowance.

Methods inherited from class com.google.protobuf.GeneratedMessageLite.Builder

build, buildPartial, clear, clone, copyOnWrite, copyOnWriteInternal, getDefaultInstanceForType, internalMergeFrom, isInitialized, mergeFrom, mergeFrom, mergeFrom, mergeFrom

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

getDefaultInstanceForType, isInitialized

Method Details

hasTokenId

public boolean hasTokenId()

 *
 The identifier for the token associated with this allowance.
 <p>
 This token MUST be a fungible/common token.
 

.proto.TokenID token_id = 1;

Specified by:

hasTokenId in interface GrantedTokenAllowanceOrBuilder

Returns:

Whether the tokenId field is set.

getTokenId

public TokenID getTokenId()

 *
 The identifier for the token associated with this allowance.
 <p>
 This token MUST be a fungible/common token.
 

.proto.TokenID token_id = 1;

Specified by:

getTokenId in interface GrantedTokenAllowanceOrBuilder

Returns:

The tokenId.

setTokenId

public GrantedTokenAllowance.Builder setTokenId(TokenID value)

 *
 The identifier for the token associated with this allowance.
 <p>
 This token MUST be a fungible/common token.
 

.proto.TokenID token_id = 1;

setTokenId

public GrantedTokenAllowance.Builder setTokenId(TokenID.Builder builderForValue)

 *
 The identifier for the token associated with this allowance.
 <p>
 This token MUST be a fungible/common token.
 

.proto.TokenID token_id = 1;

mergeTokenId

public GrantedTokenAllowance.Builder mergeTokenId(TokenID value)

 *
 The identifier for the token associated with this allowance.
 <p>
 This token MUST be a fungible/common token.
 

.proto.TokenID token_id = 1;

clearTokenId

public GrantedTokenAllowance.Builder clearTokenId()

 *
 The identifier for the token associated with this allowance.
 <p>
 This token MUST be a fungible/common token.
 

.proto.TokenID token_id = 1;

hasSpender

public boolean hasSpender()

 *
 The identifier for the spending account associated with this allowance.
 <p>
 This account SHALL be permitted to sign transactions to spend tokens
 of the associated token type from the funding/allowing account.<br/>
 This permission SHALL be limited to no more than the specified `amount`.
 

.proto.AccountID spender = 2;

Specified by:

hasSpender in interface GrantedTokenAllowanceOrBuilder

Returns:

Whether the spender field is set.

getSpender

public AccountID getSpender()

 *
 The identifier for the spending account associated with this allowance.
 <p>
 This account SHALL be permitted to sign transactions to spend tokens
 of the associated token type from the funding/allowing account.<br/>
 This permission SHALL be limited to no more than the specified `amount`.
 

.proto.AccountID spender = 2;

Specified by:

getSpender in interface GrantedTokenAllowanceOrBuilder

Returns:

The spender.

setSpender

public GrantedTokenAllowance.Builder setSpender(AccountID value)

 *
 The identifier for the spending account associated with this allowance.
 <p>
 This account SHALL be permitted to sign transactions to spend tokens
 of the associated token type from the funding/allowing account.<br/>
 This permission SHALL be limited to no more than the specified `amount`.
 

.proto.AccountID spender = 2;

setSpender

public GrantedTokenAllowance.Builder setSpender(AccountID.Builder builderForValue)

 *
 The identifier for the spending account associated with this allowance.
 <p>
 This account SHALL be permitted to sign transactions to spend tokens
 of the associated token type from the funding/allowing account.<br/>
 This permission SHALL be limited to no more than the specified `amount`.
 

.proto.AccountID spender = 2;

mergeSpender

public GrantedTokenAllowance.Builder mergeSpender(AccountID value)

 *
 The identifier for the spending account associated with this allowance.
 <p>
 This account SHALL be permitted to sign transactions to spend tokens
 of the associated token type from the funding/allowing account.<br/>
 This permission SHALL be limited to no more than the specified `amount`.
 

.proto.AccountID spender = 2;

clearSpender

public GrantedTokenAllowance.Builder clearSpender()

 *
 The identifier for the spending account associated with this allowance.
 <p>
 This account SHALL be permitted to sign transactions to spend tokens
 of the associated token type from the funding/allowing account.<br/>
 This permission SHALL be limited to no more than the specified `amount`.
 

.proto.AccountID spender = 2;

getAmount

public long getAmount()

 The maximum amount that the spender account may transfer within
 the scope of this allowance.
 <p>
 This allowance SHALL be consumed if any combination of transfers
 authorized via this allowance meet this value in total.<br/>
 This value MUST be specified in the smallest units of the relevant
 token (i.e. 10<sup>-decimals</sup> whole tokens).
 

int64 amount = 3;

Specified by:

getAmount in interface GrantedTokenAllowanceOrBuilder

Returns:

The amount.

setAmount

public GrantedTokenAllowance.Builder setAmount(long value)

 The maximum amount that the spender account may transfer within
 the scope of this allowance.
 <p>
 This allowance SHALL be consumed if any combination of transfers
 authorized via this allowance meet this value in total.<br/>
 This value MUST be specified in the smallest units of the relevant
 token (i.e. 10<sup>-decimals</sup> whole tokens).
 

int64 amount = 3;

Parameters:

value - The amount to set.

Returns:

This builder for chaining.

clearAmount

public GrantedTokenAllowance.Builder clearAmount()

 The maximum amount that the spender account may transfer within
 the scope of this allowance.
 <p>
 This allowance SHALL be consumed if any combination of transfers
 authorized via this allowance meet this value in total.<br/>
 This value MUST be specified in the smallest units of the relevant
 token (i.e. 10<sup>-decimals</sup> whole tokens).
 

int64 amount = 3;

Returns:

This builder for chaining.