Package net.corda.v5.ledger.utxo.observer

Class UtxoTokenPoolKey

  • All Implemented Interfaces:
    
public final class UtxoTokenPoolKey

    Represents a key for a pool of similar tokens.

    The full token pool key includes holding ID, token type, issue, notary and symbol. The platform provides the holding ID, notary and optional token type.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      String getTokenType() Gets the type of token within a pool, or null if no type was specified.
      SecureHash getIssuerHash() Gets the SecureHash of the issuer of the tokens in a pool.
      String getSymbol() Gets the user-defined symbol of the tokens in a pool.
      boolean equals(Object obj) Determines whether the specified object is equal to the current object.
      boolean equals(@NotNull() UtxoTokenPoolKey other) Determines whether the specified object is equal to the current object.
      int hashCode() Serves as the default hash function.
      String toString() Returns a string that represents the current object.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • UtxoTokenPoolKey

        UtxoTokenPoolKey(String tokenType, SecureHash issuerHash, String symbol)
        Creates a new instance of the UtxoTokenPoolKey class.
        Parameters:
        tokenType - The type of token within a pool.
        issuerHash - The SecureHash of the issuer of the tokens in a pool.
        symbol - The user-defined symbol of the tokens in a pool.

      • UtxoTokenPoolKey

        UtxoTokenPoolKey(SecureHash issuerHash, String symbol)
        Creates a new instance of the UtxoTokenPoolKey class.
        Parameters:
        issuerHash - The SecureHash of the issuer of the tokens in a pool.
        symbol - The user-defined symbol of the tokens in a pool.

    • Method Detail

      • getTokenType

        @Nullable() String getTokenType()

        Gets the type of token within a pool, or null if no type was specified.

      • getSymbol

        @NotNull() String getSymbol()

        Gets the user-defined symbol of the tokens in a pool.

      • equals

         boolean equals(Object obj)

        Determines whether the specified object is equal to the current object.

        Parameters:
        obj - The object to compare with the current object.

      • equals

         boolean equals(@NotNull() UtxoTokenPoolKey other)

        Determines whether the specified object is equal to the current object.

        Parameters:
        other - The Party to compare with the current object.

      • hashCode

         int hashCode()

        Serves as the default hash function.

      • toString

         String toString()

        Returns a string that represents the current object.