Enum KnockType

  • All Implemented Interfaces:
    Named, NamedEnum, java.io.Serializable, java.lang.Comparable<KnockType>

    public enum KnockType
    extends java.lang.Enum<KnockType>
    implements NamedEnum
    The knock type of barrier event.

    This defines the knock type of Barrier.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      KNOCK_IN
      Knock-in
      KNOCK_OUT
      Knock-out
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean isKnockIn()
      Checks if the type is 'Knock-in'.
      static KnockType of​(java.lang.String name)
      Obtains an instance from the specified name.
      java.lang.String toString()
      Returns the formatted name of the type.
      static KnockType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static KnockType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface com.opengamma.strata.collect.named.NamedEnum

        getName
    • Enum Constant Detail

      • KNOCK_IN

        public static final KnockType KNOCK_IN
        Knock-in
      • KNOCK_OUT

        public static final KnockType KNOCK_OUT
        Knock-out
    • Method Detail

      • values

        public static KnockType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (KnockType c : KnockType.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static KnockType valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • of

        public static KnockType of​(java.lang.String name)
        Obtains an instance from the specified name.

        Parsing handles the mixed case form produced by toString() and the upper and lower case variants of the enum constant name.

        Parameters:
        name - the name to parse
        Returns:
        the type
        Throws:
        java.lang.IllegalArgumentException - if the name is not known
      • isKnockIn

        public boolean isKnockIn()
        Checks if the type is 'Knock-in'.
        Returns:
        true if knock-in, false if knock-out
      • toString

        public java.lang.String toString()
        Returns the formatted name of the type.
        Overrides:
        toString in class java.lang.Enum<KnockType>
        Returns:
        the formatted string representing the type