Enum ProtectionStartOfDay

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BEGINNING
      Beginning of the start day.
      NONE
      None.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean isBeginning()
      Check if the type is 'Beginning'.
      static ProtectionStartOfDay of​(java.lang.String name)
      Obtains an instance from the specified name.
      java.lang.String toString()
      Returns the formatted name of the type.
      static ProtectionStartOfDay valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ProtectionStartOfDay[] 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

      • BEGINNING

        public static final ProtectionStartOfDay BEGINNING
        Beginning of the start day.

        The protection starts at the beginning of the day.

      • NONE

        public static final ProtectionStartOfDay NONE
        None.

        The protection start is not specified. The CDS is priced based on the default date logic in respective model implementation.

    • Method Detail

      • values

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

        public static ProtectionStartOfDay 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 ProtectionStartOfDay 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
      • isBeginning

        public boolean isBeginning()
        Check if the type is 'Beginning'.
        Returns:
        true if beginning, false otherwise
      • toString

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