TimerPayloadDescriptor (Elara Event Sourcing)

java.lang.Object
- java.lang.Enum<TimerPayloadDescriptor>
- - org.tools4j.elara.plugin.timer.TimerPayloadDescriptor

All Implemented Interfaces:: Serializable, Comparable<TimerPayloadDescriptor>

public enum TimerPayloadDescriptor
extends Enum<TimerPayloadDescriptor>

Descriptor of payload layout for timer commands and events in a byte buffer.


 0         1         2         3         4         5         6
 0 2 4 6 8 0 2 4 6 8 0 2 4 6 8 0 2 4 6 8 0 2 4 6 8 0 2 4 6 8 0 2 4
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |                           Timer ID                            |
 +-------+-------+-------+-------+-------+-------+-------+-------+
 |          Timer Type           |           Repetition          |
 +-------+-------+-------+-------+-------+-------+-------+-------+
 |                            Timeout                            |
 +-------+-------+-------+-------+-------+-------+-------+-------+

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`PAYLOAD_SIZE`
`static int`	`TIMER_ID_LENGTH`
`static int`	`TIMER_ID_OFFSET`
`static int`	`TIMER_REPETITION_LENGTH`
`static int`	`TIMER_REPETITION_OFFSET`
`static int`	`TIMER_TIMEOUT_LENGTH`
`static int`	`TIMER_TIMEOUT_OFFSET`
`static int`	`TIMER_TYPE_LENGTH`
`static int`	`TIMER_TYPE_OFFSET`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static long`	`timerId(DirectBuffer payload)`
`static int`	`timerRepetition(DirectBuffer payload)`
`static long`	`timerTimeout(DirectBuffer payload)`
`static int`	`timerType(DirectBuffer payload)`
`static TimerPayloadDescriptor`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static TimerPayloadDescriptor[]`	`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

- Field Detail
  - TIMER_ID_OFFSET
```
public static final int TIMER_ID_OFFSET
```
    See Also:
    
    Constant Field Values
  - TIMER_ID_LENGTH
```
public static final int TIMER_ID_LENGTH
```
    See Also:
    
    Constant Field Values
  - TIMER_TYPE_OFFSET
```
public static final int TIMER_TYPE_OFFSET
```
    See Also:
    
    Constant Field Values
  - TIMER_TYPE_LENGTH
```
public static final int TIMER_TYPE_LENGTH
```
    See Also:
    
    Constant Field Values
  - TIMER_REPETITION_OFFSET
```
public static final int TIMER_REPETITION_OFFSET
```
    See Also:
    
    Constant Field Values
  - TIMER_REPETITION_LENGTH
```
public static final int TIMER_REPETITION_LENGTH
```
    See Also:
    
    Constant Field Values
  - TIMER_TIMEOUT_OFFSET
```
public static final int TIMER_TIMEOUT_OFFSET
```
    See Also:
    
    Constant Field Values
  - TIMER_TIMEOUT_LENGTH
```
public static final int TIMER_TIMEOUT_LENGTH
```
    See Also:
    
    Constant Field Values
  - PAYLOAD_SIZE
```
public static final int PAYLOAD_SIZE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - values
```
public static TimerPayloadDescriptor[] 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 (TimerPayloadDescriptor c : TimerPayloadDescriptor.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static TimerPayloadDescriptor 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
  - timerId
```
public static long timerId(DirectBuffer payload)
```
  - timerType
```
public static int timerType(DirectBuffer payload)
```
  - timerRepetition
```
public static int timerRepetition(DirectBuffer payload)
```
  - timerTimeout
```
public static long timerTimeout(DirectBuffer payload)
```

Enum TimerPayloadDescriptor

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Field Detail

TIMER_ID_OFFSET

TIMER_ID_LENGTH

TIMER_TYPE_OFFSET

TIMER_TYPE_LENGTH

TIMER_REPETITION_OFFSET

TIMER_REPETITION_LENGTH

TIMER_TIMEOUT_OFFSET

TIMER_TIMEOUT_LENGTH

PAYLOAD_SIZE

Method Detail

values

valueOf

timerId

timerType

timerRepetition

timerTimeout