org.jfin.date

Enum StubType

java.lang.Object

java.lang.Enum<StubType>

org.jfin.date.StubType

All Implemented Interfaces:

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

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

Enumeration of the various stub types, currently supports:

• Undajusted
• Preceding
• Modified Preceding
• Following
• Modified Following
• Month End Reference

Enum Constant Summary

Enum Constants

Enum Constant and Description
LONG_FIRST The long stub period is at the start of the schedule, e.g.: X.....X...X...X...X...X...X
LONG_LAST The long stub period is at the end of the schedule X...X...X...X...X...X.....X
NONE There should be no stub period, if the frequency doesn't exactly fit the start/end date then an exception will be thrown X...X...X...X...X...X...X
SHORT_FIRST The short stub period is at the start of the schedule, e.g.: X.X...X...X...X...X...X...X
SHORT_LAST The short stub period is at the end of the schedule X...X...X...X...X...X...X.X

Method Summary

Modifier and Type	Method and Description
boolean	isLongStub()
boolean	isShortStub()
static StubType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static StubType[]	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

SHORT_FIRST

public static final StubType SHORT_FIRST

The short stub period is at the start of the schedule, e.g.: X.X...X...X...X...X...X...X

SHORT_LAST

public static final StubType SHORT_LAST

The short stub period is at the end of the schedule X...X...X...X...X...X...X.X

LONG_FIRST

public static final StubType LONG_FIRST

The long stub period is at the start of the schedule, e.g.: X.....X...X...X...X...X...X

LONG_LAST

public static final StubType LONG_LAST

The long stub period is at the end of the schedule X...X...X...X...X...X.....X

NONE

public static final StubType NONE

There should be no stub period, if the frequency doesn't exactly fit the start/end date then an exception will be thrown X...X...X...X...X...X...X

Method Detail

values

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

Returns:

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

valueOf

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

isLongStub

public boolean isLongStub()

isShortStub

public boolean isShortStub()