com.hedera.hapi.node.state.token.TokenRelation Maven / Gradle / Ivy
package com.hedera.hapi.node.state.token;
import com.hedera.hapi.node.base.*;
import com.hedera.pbj.runtime.*;
import com.hedera.pbj.runtime.io.*;
import com.hedera.pbj.runtime.io.buffer.*;
import com.hedera.pbj.runtime.io.stream.*;
import edu.umd.cs.findbugs.annotations.*;
import com.hedera.pbj.runtime.Codec;
import java.util.function.Consumer;
import edu.umd.cs.findbugs.annotations.Nullable;
import edu.umd.cs.findbugs.annotations.NonNull;
import static java.util.Objects.requireNonNull;
/**
* Representation of a Hedera Token Service token relationship entity in the network Merkle tree.
*
* As with all network entities, a token relationship has a unique entity number pair, which is represented
* with the account and the token involved in the relationship.
*
* @param tokenId (1) The token involved in this relation.It takes only positive
* @param accountId (2) The account involved in this association.
* @param balance (3) The balance of the token relationship.
* @param frozen (4) The flags specifying the token relationship is frozen or not.
* @param kycGranted (5) The flag indicating if the token relationship has been granted KYC.
* @param automaticAssociation (6) The flag indicating if the token relationship was created using automatic association.
* @param previousToken (7) The previous token id of account's association linked list
* @param nextToken (8) The next token id of account's association linked list
*/
public record TokenRelation(
@Nullable TokenID tokenId,
@Nullable AccountID accountId,
long balance,
boolean frozen,
boolean kycGranted,
boolean automaticAssociation,
@Nullable TokenID previousToken,
@Nullable TokenID nextToken
) {
/** Protobuf codec for reading and writing in protobuf format */
public static final Codec PROTOBUF = new com.hedera.hapi.node.state.token.codec.TokenRelationProtoCodec();
/** JSON codec for reading and writing in JSON format */
public static final JsonCodec JSON = new com.hedera.hapi.node.state.token.codec.TokenRelationJsonCodec();
/** Default instance with all fields set to default values */
public static final TokenRelation DEFAULT = newBuilder().build();
/**
* Create a pre-populated TokenRelation.
*
* @param tokenId (1) The token involved in this relation.It takes only positive,
* @param accountId (2) The account involved in this association.,
* @param balance (3) The balance of the token relationship.,
* @param frozen (4) The flags specifying the token relationship is frozen or not.,
* @param kycGranted (5) The flag indicating if the token relationship has been granted KYC.,
* @param automaticAssociation (6) The flag indicating if the token relationship was created using automatic association.,
* @param previousToken (7) The previous token id of account's association linked list,
* @param nextToken (8) The next token id of account's association linked list
*/
public TokenRelation(TokenID tokenId, AccountID accountId, long balance, boolean frozen, boolean kycGranted, boolean automaticAssociation, TokenID previousToken, TokenID nextToken) {
this.tokenId = tokenId;
this.accountId = accountId;
this.balance = balance;
this.frozen = frozen;
this.kycGranted = kycGranted;
this.automaticAssociation = automaticAssociation;
this.previousToken = previousToken;
this.nextToken = nextToken;
}
/**
* Override the default hashCode method for
* all other objects to make hashCode
*/
@Override
public int hashCode() {
int result = 1;
if (tokenId != null && !tokenId.equals(DEFAULT.tokenId)) {
result = 31 * result + tokenId.hashCode();
}
if (accountId != null && !accountId.equals(DEFAULT.accountId)) {
result = 31 * result + accountId.hashCode();
}
if (balance != DEFAULT.balance) {
result = 31 * result + Long.hashCode(balance);
}
if (frozen != DEFAULT.frozen) {
result = 31 * result + Boolean.hashCode(frozen);
}
if (kycGranted != DEFAULT.kycGranted) {
result = 31 * result + Boolean.hashCode(kycGranted);
}
if (automaticAssociation != DEFAULT.automaticAssociation) {
result = 31 * result + Boolean.hashCode(automaticAssociation);
}
if (previousToken != null && !previousToken.equals(DEFAULT.previousToken)) {
result = 31 * result + previousToken.hashCode();
}
if (nextToken != null && !nextToken.equals(DEFAULT.nextToken)) {
result = 31 * result + nextToken.hashCode();
}
long hashCode = result;
// Shifts: 30, 27, 16, 20, 5, 18, 10, 24, 30
hashCode += hashCode << 30;
hashCode ^= hashCode >>> 27;
hashCode += hashCode << 16;
hashCode ^= hashCode >>> 20;
hashCode += hashCode << 5;
hashCode ^= hashCode >>> 18;
hashCode += hashCode << 10;
hashCode ^= hashCode >>> 24;
hashCode += hashCode << 30;
return (int)hashCode;
}
/**
* Override the default equals method for
*/
@Override
public boolean equals(Object that) {
if (that == null || this.getClass() != that.getClass()) {
return false;
}
TokenRelation thatObj = (TokenRelation)that;
if (tokenId == null && thatObj.tokenId != null) {
return false;
}
if (tokenId != null && !tokenId.equals(thatObj.tokenId)) {
return false;
}
if (accountId == null && thatObj.accountId != null) {
return false;
}
if (accountId != null && !accountId.equals(thatObj.accountId)) {
return false;
}
if (balance != thatObj.balance) {
return false;
}
if (frozen != thatObj.frozen) {
return false;
}
if (kycGranted != thatObj.kycGranted) {
return false;
}
if (automaticAssociation != thatObj.automaticAssociation) {
return false;
}
if (previousToken == null && thatObj.previousToken != null) {
return false;
}
if (previousToken != null && !previousToken.equals(thatObj.previousToken)) {
return false;
}
if (nextToken == null && thatObj.nextToken != null) {
return false;
}
if (nextToken != null && !nextToken.equals(thatObj.nextToken)) {
return false;
}
return true;
}
/**
* Convenience method to check if the tokenId has a value
*
* @return true of the tokenId has a value
*/
public boolean hasTokenId() {
return tokenId != null;
}
/**
* Gets the value for tokenId if it has a value, or else returns the default
* value for the type.
*
* @param defaultValue the default value to return if tokenId is null
* @return the value for tokenId if it has a value, or else returns the default value
*/
public TokenID tokenIdOrElse(@NonNull final TokenID defaultValue) {
return hasTokenId() ? tokenId : defaultValue;
}
/**
* Gets the value for tokenId if it has a value, or else throws an NPE.
* value for the type.
*
* @return the value for tokenId if it has a value
* @throws NullPointerException if tokenId is null
*/
public @NonNull TokenID tokenIdOrThrow() {
return requireNonNull(tokenId, "Field tokenId is null");
}
/**
* Executes the supplied {@link Consumer} if, and only if, the tokenId has a value
*
* @param ifPresent the {@link Consumer} to execute
*/
public void ifTokenId(@NonNull final Consumer ifPresent) {
if (hasTokenId()) {
ifPresent.accept(tokenId);
}
}
/**
* Convenience method to check if the accountId has a value
*
* @return true of the accountId has a value
*/
public boolean hasAccountId() {
return accountId != null;
}
/**
* Gets the value for accountId if it has a value, or else returns the default
* value for the type.
*
* @param defaultValue the default value to return if accountId is null
* @return the value for accountId if it has a value, or else returns the default value
*/
public AccountID accountIdOrElse(@NonNull final AccountID defaultValue) {
return hasAccountId() ? accountId : defaultValue;
}
/**
* Gets the value for accountId if it has a value, or else throws an NPE.
* value for the type.
*
* @return the value for accountId if it has a value
* @throws NullPointerException if accountId is null
*/
public @NonNull AccountID accountIdOrThrow() {
return requireNonNull(accountId, "Field accountId is null");
}
/**
* Executes the supplied {@link Consumer} if, and only if, the accountId has a value
*
* @param ifPresent the {@link Consumer} to execute
*/
public void ifAccountId(@NonNull final Consumer ifPresent) {
if (hasAccountId()) {
ifPresent.accept(accountId);
}
}
/**
* Convenience method to check if the previousToken has a value
*
* @return true of the previousToken has a value
*/
public boolean hasPreviousToken() {
return previousToken != null;
}
/**
* Gets the value for previousToken if it has a value, or else returns the default
* value for the type.
*
* @param defaultValue the default value to return if previousToken is null
* @return the value for previousToken if it has a value, or else returns the default value
*/
public TokenID previousTokenOrElse(@NonNull final TokenID defaultValue) {
return hasPreviousToken() ? previousToken : defaultValue;
}
/**
* Gets the value for previousToken if it has a value, or else throws an NPE.
* value for the type.
*
* @return the value for previousToken if it has a value
* @throws NullPointerException if previousToken is null
*/
public @NonNull TokenID previousTokenOrThrow() {
return requireNonNull(previousToken, "Field previousToken is null");
}
/**
* Executes the supplied {@link Consumer} if, and only if, the previousToken has a value
*
* @param ifPresent the {@link Consumer} to execute
*/
public void ifPreviousToken(@NonNull final Consumer ifPresent) {
if (hasPreviousToken()) {
ifPresent.accept(previousToken);
}
}
/**
* Convenience method to check if the nextToken has a value
*
* @return true of the nextToken has a value
*/
public boolean hasNextToken() {
return nextToken != null;
}
/**
* Gets the value for nextToken if it has a value, or else returns the default
* value for the type.
*
* @param defaultValue the default value to return if nextToken is null
* @return the value for nextToken if it has a value, or else returns the default value
*/
public TokenID nextTokenOrElse(@NonNull final TokenID defaultValue) {
return hasNextToken() ? nextToken : defaultValue;
}
/**
* Gets the value for nextToken if it has a value, or else throws an NPE.
* value for the type.
*
* @return the value for nextToken if it has a value
* @throws NullPointerException if nextToken is null
*/
public @NonNull TokenID nextTokenOrThrow() {
return requireNonNull(nextToken, "Field nextToken is null");
}
/**
* Executes the supplied {@link Consumer} if, and only if, the nextToken has a value
*
* @param ifPresent the {@link Consumer} to execute
*/
public void ifNextToken(@NonNull final Consumer ifPresent) {
if (hasNextToken()) {
ifPresent.accept(nextToken);
}
}
/**
* Return a builder for building a copy of this model object. It will be pre-populated with all the data from this
* model object.
*
* @return a pre-populated builder
*/
public Builder copyBuilder() {
return new Builder(tokenId, accountId, balance, frozen, kycGranted, automaticAssociation, previousToken, nextToken);
}
/**
* Return a new builder for building a model object. This is just a shortcut for new Model.Builder().
*
* @return a new builder
*/
public static Builder newBuilder() {
return new Builder();
}
/**
* Builder class for easy creation, ideal for clean code where performance is not critical. In critical performance
* paths use the constructor directly.
*/
public static final class Builder {
@Nullable private TokenID tokenId = null;
@Nullable private AccountID accountId = null;
private long balance = 0;
private boolean frozen = false;
private boolean kycGranted = false;
private boolean automaticAssociation = false;
@Nullable private TokenID previousToken = null;
@Nullable private TokenID nextToken = null;
/**
* Create an empty builder
*/
public Builder() {}
/**
* Create a pre-populated Builder.
*
* @param tokenId (1) The token involved in this relation.It takes only positive,
* @param accountId (2) The account involved in this association.,
* @param balance (3) The balance of the token relationship.,
* @param frozen (4) The flags specifying the token relationship is frozen or not.,
* @param kycGranted (5) The flag indicating if the token relationship has been granted KYC.,
* @param automaticAssociation (6) The flag indicating if the token relationship was created using automatic association.,
* @param previousToken (7) The previous token id of account's association linked list,
* @param nextToken (8) The next token id of account's association linked list
*/
public Builder(TokenID tokenId, AccountID accountId, long balance, boolean frozen, boolean kycGranted, boolean automaticAssociation, TokenID previousToken, TokenID nextToken) {
this.tokenId = tokenId;
this.accountId = accountId;
this.balance = balance;
this.frozen = frozen;
this.kycGranted = kycGranted;
this.automaticAssociation = automaticAssociation;
this.previousToken = previousToken;
this.nextToken = nextToken;
}
/**
* Build a new model record with data set on builder
*
* @return new model record with data set
*/
public TokenRelation build() {
return new TokenRelation(tokenId, accountId, balance, frozen, kycGranted, automaticAssociation, previousToken, nextToken);
}
/**
* (1) The token involved in this relation.It takes only positive
*
* @param tokenId value to set
* @return builder to continue building with
*/
public Builder tokenId(@Nullable TokenID tokenId) {
this.tokenId = tokenId;
return this;
}
/**
* (1) The token involved in this relation.It takes only positive
*
* @param builder A pre-populated builder
* @return builder to continue building with
*/
public Builder tokenId(TokenID.Builder builder) {
this.tokenId = builder.build() ;
return this;
}
/**
* (2) The account involved in this association.
*
* @param accountId value to set
* @return builder to continue building with
*/
public Builder accountId(@Nullable AccountID accountId) {
this.accountId = accountId;
return this;
}
/**
* (2) The account involved in this association.
*
* @param builder A pre-populated builder
* @return builder to continue building with
*/
public Builder accountId(AccountID.Builder builder) {
this.accountId = builder.build() ;
return this;
}
/**
* (3) The balance of the token relationship.
*
* @param balance value to set
* @return builder to continue building with
*/
public Builder balance(long balance) {
this.balance = balance;
return this;
}
/**
* (4) The flags specifying the token relationship is frozen or not.
*
* @param frozen value to set
* @return builder to continue building with
*/
public Builder frozen(boolean frozen) {
this.frozen = frozen;
return this;
}
/**
* (5) The flag indicating if the token relationship has been granted KYC.
*
* @param kycGranted value to set
* @return builder to continue building with
*/
public Builder kycGranted(boolean kycGranted) {
this.kycGranted = kycGranted;
return this;
}
/**
* (6) The flag indicating if the token relationship was created using automatic association.
*
* @param automaticAssociation value to set
* @return builder to continue building with
*/
public Builder automaticAssociation(boolean automaticAssociation) {
this.automaticAssociation = automaticAssociation;
return this;
}
/**
* (7) The previous token id of account's association linked list
*
* @param previousToken value to set
* @return builder to continue building with
*/
public Builder previousToken(@Nullable TokenID previousToken) {
this.previousToken = previousToken;
return this;
}
/**
* (7) The previous token id of account's association linked list
*
* @param builder A pre-populated builder
* @return builder to continue building with
*/
public Builder previousToken(TokenID.Builder builder) {
this.previousToken = builder.build() ;
return this;
}
/**
* (8) The next token id of account's association linked list
*
* @param nextToken value to set
* @return builder to continue building with
*/
public Builder nextToken(@Nullable TokenID nextToken) {
this.nextToken = nextToken;
return this;
}
/**
* (8) The next token id of account's association linked list
*
* @param builder A pre-populated builder
* @return builder to continue building with
*/
public Builder nextToken(TokenID.Builder builder) {
this.nextToken = builder.build() ;
return this;
}
}
}