Class ResolvedTradeParameterMetadata

  • All Implemented Interfaces:
    ParameterMetadata, java.io.Serializable, org.joda.beans.Bean, org.joda.beans.ImmutableBean

    public final class ResolvedTradeParameterMetadata
    extends java.lang.Object
    implements ParameterMetadata, org.joda.beans.ImmutableBean, java.io.Serializable
    Parameter metadata based on a resolved trade and label.
    See Also:
    Serialized Form
    • Method Detail

      • of

        public static ResolvedTradeParameterMetadata of​(ResolvedTrade trade,
                                                        java.lang.String label)
        Obtains an instance specifying the trade and label.
        Parameters:
        trade - the resolved trade
        label - the label
        Returns:
        the instance
      • getIdentifier

        public java.lang.String getIdentifier()
        Description copied from interface: ParameterMetadata
        Returns an object used to identify the parameter.

        A good choice of identifier is one that makes sense to the user and can easily be created as part of a scenario definition. For example, many nodes types are naturally identified by a tenor.

        The identifier must satisfy the following criteria:

        • It must be non-null
        • It should be unique within a single data set
        • It should have a sensible implementation of hashCode() and equals().
        Otherwise the choice of identifier is free and the system makes no assumptions about it.
        Specified by:
        getIdentifier in interface ParameterMetadata
        Returns:
        an object used to uniquely identify the parameter within the data
      • getTrade

        public ResolvedTrade getTrade()
        Gets the trade that describes the parameter.
        Returns:
        the value of the property, not null
      • getLabel

        public java.lang.String getLabel()
        Gets the label that describes the parameter.
        Specified by:
        getLabel in interface ParameterMetadata
        Returns:
        the value of the property, not empty
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object