Enum CompoundedRateType

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

    public enum CompoundedRateType
    extends java.lang.Enum<CompoundedRateType>
    implements NamedEnum
    A compounded rate type.

    Compounded rate is continuously compounded rate or periodically compounded rate. The main application of this is z-spread computation under a specific way of compounding. See, for example, DiscountFactors.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CONTINUOUS
      Continuous compounding.
      PERIODIC
      Periodic compounding.
    • Method Summary

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

      • PERIODIC

        public static final CompoundedRateType PERIODIC
        Periodic compounding.

        The rate is periodically compounded. In this case the number of periods par year should be specified in addition.

      • CONTINUOUS

        public static final CompoundedRateType CONTINUOUS
        Continuous compounding.

        The rate is continuously compounded.

    • Method Detail

      • values

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

        public static CompoundedRateType 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 CompoundedRateType 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
      • toString

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