TimerPreserveMissed (jslee-api API documentation)

java.lang.Object
- javax.slee.facilities.TimerPreserveMissed

All Implemented Interfaces:

Serializable
```
public final class TimerPreserveMissed
extends Object
implements Serializable
```
This class defines an enumerated type for the late-timer preservation options suppored by the Timer Facility. A singleton instance of each enumerated value is guaranteed (via an implementation of readResolve() - refer java.io.Serializable), so that equality tests using == are always evaluated correctly. (This equality test is only guaranteed if this class is loaded in the application's boot class path, rather than dynamically loaded at runtime.)
The late-timer preservation options are:
- NONE - timer events for a late timer are not generated.
- ALL - timer events for a late timer are always generated.
- LAST - only one timer event is generated for a late timer, that event corresponding to the most recent firing of the timer.
See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static TimerPreserveMissed`	`ALL` Preserve-missed value for the ALL option.
`static String`	`ALL_STRING` A string representation of `ALL`.
`static TimerPreserveMissed`	`LAST` Preserve-missed value for the LAST option.
`static String`	`LAST_STRING` A string representation of `LAST`.
`static TimerPreserveMissed`	`NONE` Preserve-missed value for the NONE option.
`static String`	`NONE_STRING` A string representation of `NONE`.
`static int`	`PRESERVE_ALL` An integer representation of `ALL`.
`static int`	`PRESERVE_LAST` An integer representation of `LAST`.
`static int`	`PRESERVE_NONE` An integer representation of `NONE`.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)` Compare this preserve-missed option object for equality with another.
`static TimerPreserveMissed`	`fromInt(int option)` Get a `TimerPreserveMissed` object from an integer value.
`static TimerPreserveMissed`	`fromString(String option)` Get a `TimerPreserveMissed` object from a string value.
`int`	`hashCode()` Get a hash code value for this preserve-missed option object.
`boolean`	`isAll()` Determine if this TimerPreserveMissed object represents the ALL option.
`boolean`	`isLast()` Determine if this TimerPreserveMissed object represents the LAST option.
`boolean`	`isNone()` Determine if this TimerPreserveMissed object represents the NONE option.
`int`	`toInt()` Get an integer value representation for this `TimerPreserveMissed` object.
`String`	`toString()` Get the textual representation of the TimerPreserveMissed object.

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

- Field Detail
  - PRESERVE_NONE
```
public static final int PRESERVE_NONE
```
    An integer representation of NONE.
    
    See Also:
    Constant Field Values
  - PRESERVE_ALL
```
public static final int PRESERVE_ALL
```
    An integer representation of ALL.
    
    See Also:
    Constant Field Values
  - PRESERVE_LAST
```
public static final int PRESERVE_LAST
```
    An integer representation of LAST.
    
    See Also:
    Constant Field Values
  - NONE_STRING
```
public static final String NONE_STRING
```
    A string representation of NONE.
    
    See Also:
    Constant Field Values
  - ALL_STRING
```
public static final String ALL_STRING
```
    A string representation of ALL.
    
    See Also:
    Constant Field Values
  - LAST_STRING
```
public static final String LAST_STRING
```
    A string representation of LAST.
    
    See Also:
    Constant Field Values
  - NONE
```
public static final TimerPreserveMissed NONE
```
    Preserve-missed value for the NONE option.
  - ALL
```
public static final TimerPreserveMissed ALL
```
    Preserve-missed value for the ALL option.
  - LAST
```
public static final TimerPreserveMissed LAST
```
    Preserve-missed value for the LAST option.
- Method Detail
  - fromInt
```
public static TimerPreserveMissed fromInt(int option)
                                   throws IllegalArgumentException
```
    Get a TimerPreserveMissed object from an integer value.
    
    Parameters:
    option - the preserve-missed option as an integer.
    
    Returns:
    a TimerPreserveMissed object corresponding to option.
    
    Throws:
    
    IllegalArgumentException - if option is not a valid preserve-missed option value.
  - fromString
```
public static TimerPreserveMissed fromString(String option)
                                      throws NullPointerException,
                                             IllegalArgumentException
```
    Get a TimerPreserveMissed object from a string value.
    
    Parameters:
    option - the preserve-missed option as a string, for example as returned by the toString() method (case insensitive).
    
    Returns:
    a TimerPreserveMissed object corresponding to option.
    
    Throws:
    
    NullPointerException - if option is null.
    
    IllegalArgumentException - if option is not a valid preserve-missed option value.
    Since:
    
    SLEE 1.1
  - toInt
```
public int toInt()
```
    Get an integer value representation for this TimerPreserveMissed object.
    
    Returns:
    an integer value representation for this TimerPreserveMissed object.
  - isNone
```
public boolean isNone()
```
    Determine if this TimerPreserveMissed object represents the NONE option.
    This method is effectively equivalent to the conditional test: (this == NONE), ie. the code:
    if (timerPreserveMissed.isNone()) ...
    is interchangeable with the code:
    if (timerPreserveMissed == TimerPreserveMissed.NONE) ...
    
    Returns:
    true if this object represents the NONE option, false otherwise.
  - isAll
```
public boolean isAll()
```
    Determine if this TimerPreserveMissed object represents the ALL option.
    This method is effectively equivalent to the conditional test: (this == ALL), ie. the code:
    if (timerPreserveMissed.isAll()) ...
    is interchangeable with the code:
    if (timerPreserveMissed == TimerPreserveMissed.ALL) ...
    
    Returns:
    true if this object represents the ALL option, false otherwise.
  - isLast
```
public boolean isLast()
```
    Determine if this TimerPreserveMissed object represents the LAST option.
    This method is effectively equivalent to the conditional test: (this == LAST), ie. the code:
    if (timerPreserveMissed.isLast()) ...
    is interchangeable with the code:
    if (timerPreserveMissed == TimerPreserveMissed.LAST) ...
    
    Returns:
    true if this object represents the LAST option, false otherwise.
  - equals
```
public boolean equals(Object obj)
```
    Compare this preserve-missed option object for equality with another.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    obj - the object to compare this with.
    
    Returns:
    true if obj is an instance of this class representing the same preserve-missed option as this, false otherwise.
  - hashCode
```
public int hashCode()
```
    Get a hash code value for this preserve-missed option object.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    a hash code value.
  - toString
```
public String toString()
```
    Get the textual representation of the TimerPreserveMissed object.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    the textual representation of the TimerPreserveMissed object.

Class TimerPreserveMissed

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PRESERVE_NONE

PRESERVE_ALL

PRESERVE_LAST

NONE_STRING

ALL_STRING

LAST_STRING

NONE

ALL

LAST

Method Detail

fromInt

fromString

toInt

isNone

isAll

isLast

equals

hashCode

toString