org.jquantlib.time

Enum BusinessDayConvention

java.lang.Object

java.lang.Enum<BusinessDayConvention>

org.jquantlib.time.BusinessDayConvention

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BusinessDayConvention>

public enum BusinessDayConvention
extends java.lang.Enum<BusinessDayConvention>

Business Day conventions These conventions specify the algorithm used to adjust a date in case it is not a valid business day.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Following Choose the first business day after the given holiday.
ModifiedFollowing Choose the first business day after the given holiday unless it belongs to a different month, in which case choose the first business day before the holiday.
ModifiedPreceding Choose the first business day before the given holiday unless it belongs to a different month, in which case choose the first business day after the holiday.
Preceding Choose the first business day before the given holiday.
Unadjusted Do not adjust.

Method Summary

Modifier and Type	Method and Description
static BusinessDayConvention	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BusinessDayConvention[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Following

public static final BusinessDayConvention Following

Choose the first business day after the given holiday.

ModifiedFollowing

public static final BusinessDayConvention ModifiedFollowing

Choose the first business day after the given holiday unless it belongs to a different month, in which case choose the first business day before the holiday.

Preceding

public static final BusinessDayConvention Preceding

Choose the first business day before the given holiday.

ModifiedPreceding

public static final BusinessDayConvention ModifiedPreceding

Choose the first business day before the given holiday unless it belongs to a different month, in which case choose the first business day after the holiday.

Unadjusted

public static final BusinessDayConvention Unadjusted

Do not adjust.

Method Detail

values

public static BusinessDayConvention[] 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 (BusinessDayConvention c : BusinessDayConvention.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BusinessDayConvention 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