Enum LongShort

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

    public enum LongShort
    extends java.lang.Enum<LongShort>
    implements NamedEnum
    Flag indicating whether a trade is "long" or "short".

    A long position is one where a financial instrument is bought with the expectation that its value will rise. A short position is the opposite where the expectation is that its value will fall, usually applied to the sale of a borrowed asset.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      LONG
      Long.
      SHORT
      Short.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean isLong()
      Checks if the type is 'Long'.
      boolean isShort()
      Checks if the type is 'Short'.
      static LongShort of​(java.lang.String name)
      Obtains an instance from the specified name.
      static LongShort ofLong​(boolean isLong)
      Converts a boolean "is long" flag to the enum value.
      int sign()
      Returns the sign, where 'Long' returns 1 and 'Short' returns -1.
      java.lang.String toString()
      Returns the formatted name of the type.
      static LongShort valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static LongShort[] 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

      • LONG

        public static final LongShort LONG
        Long.
      • SHORT

        public static final LongShort SHORT
        Short.
    • Method Detail

      • values

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

        public static LongShort 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 LongShort 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
      • ofLong

        public static LongShort ofLong​(boolean isLong)
        Converts a boolean "is long" flag to the enum value.
        Parameters:
        isLong - the long flag, true for long, false for short
        Returns:
        the equivalent enum
      • isLong

        public boolean isLong()
        Checks if the type is 'Long'.
        Returns:
        true if long, false if short
      • isShort

        public boolean isShort()
        Checks if the type is 'Short'.
        Returns:
        true if short, false if long
      • sign

        public int sign()
        Returns the sign, where 'Long' returns 1 and 'Short' returns -1.
        Returns:
        1 if long, -1 if short
      • toString

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