Enum PutCall

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

    public enum PutCall
    extends java.lang.Enum<PutCall>
    implements NamedEnum
    Flag indicating whether a trade is "put" or "call".

    The concepts of put and call apply to options trading. A call gives the owner the right, but not obligation, to buy the underlying at an agreed price in the future. A put gives a similar option to sell.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CALL
      Call.
      PUT
      Put.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean isCall()
      Checks if the type is 'Call'.
      boolean isPut()
      Checks if the type is 'Put'.
      static PutCall of​(java.lang.String name)
      Obtains an instance from the specified name.
      static PutCall ofPut​(boolean isPut)
      Converts a boolean "is put" flag to the enum value.
      java.lang.String toString()
      Returns the formatted name of the type.
      static PutCall valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static PutCall[] 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

      • PUT

        public static final PutCall PUT
        Put.
      • CALL

        public static final PutCall CALL
        Call.
    • Method Detail

      • values

        public static PutCall[] 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 (PutCall c : PutCall.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static PutCall 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 PutCall 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
      • ofPut

        public static PutCall ofPut​(boolean isPut)
        Converts a boolean "is put" flag to the enum value.
        Parameters:
        isPut - the put flag, true for put, false for call
        Returns:
        the equivalent enum
      • isPut

        public boolean isPut()
        Checks if the type is 'Put'.
        Returns:
        true if put, false if call
      • isCall

        public boolean isCall()
        Checks if the type is 'Call'.
        Returns:
        true if call, false if put
      • toString

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