ScheduleGenerator.ShortPeriodConvention (finmath lib 6.0.0 API)

java.lang.Object
- java.lang.Enum<ScheduleGenerator.ShortPeriodConvention>
- - net.finmath.time.ScheduleGenerator.ShortPeriodConvention

All Implemented Interfaces:

Serializable, Comparable<ScheduleGenerator.ShortPeriodConvention>

Enclosing class:

ScheduleGenerator
```
public static enum ScheduleGenerator.ShortPeriodConvention
extends Enum<ScheduleGenerator.ShortPeriodConvention>
```
Possible stub period conventions supported.

Author:

Christian Fries

Enum Constant Summary

Enum Constants
Enum Constant Description

FIRST
The first period will be shorter, if a regular period does not fit.

LAST
The last period will be shorter, if a regular period does not fit.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static ScheduleGenerator.ShortPeriodConvention`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static ScheduleGenerator.ShortPeriodConvention[]`	`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, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - FIRST
```
public static final ScheduleGenerator.ShortPeriodConvention FIRST
```
    The first period will be shorter, if a regular period does not fit.
  - LAST
```
public static final ScheduleGenerator.ShortPeriodConvention LAST
```
    The last period will be shorter, if a regular period does not fit.
- Method Detail
  - values
```
public static ScheduleGenerator.ShortPeriodConvention[] 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 (ScheduleGenerator.ShortPeriodConvention c : ScheduleGenerator.ShortPeriodConvention.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ScheduleGenerator.ShortPeriodConvention valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null