FrameDescriptor (Elara Event Sourcing)

java.lang.Object
- java.lang.Enum<FrameDescriptor>
- - org.tools4j.elara.flyweight.FrameDescriptor

All Implemented Interfaces:: Serializable, Comparable<FrameDescriptor>

public enum FrameDescriptor
extends Enum<FrameDescriptor>

Descriptor of frame layout for commands and events in a byte buffer. A frame starts with a header followed by payload data:


     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
     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     |             Input             |             Type              |
     +-------+-------+-------+-------+-------+-------+-------+-------+
     |                           Sequence                            |
     +-------+-------+-------+-------+-------+-------+-------+-------+
     |                             Time                              |
     +-------+-------+-------+-------+-------+-------+-------+-------+
     |    Version    |     Index     |         Payload Size          |
     +-------+-------+-------+-------+-------+-------+-------+-------+
     |                           Payload                             |
     |                             ...                               |

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`HEADER_LENGTH`
`static int`	`HEADER_OFFSET`
`static int`	`INDEX_LENGTH`
`static int`	`INDEX_OFFSET`
`static int`	`INPUT_LENGTH`
`static int`	`INPUT_OFFSET`
`static int`	`PAYLOAD_OFFSET`
`static int`	`PAYLOAD_SIZE_LENGTH`
`static int`	`PAYLOAD_SIZE_OFFSET`
`static int`	`SEQUENCE_LENGTH`
`static int`	`SEQUENCE_OFFSET`
`static int`	`TIME_LENGTH`
`static int`	`TIME_OFFSET`
`static int`	`TYPE_LENGTH`
`static int`	`TYPE_OFFSET`
`static int`	`VERSION_LENGTH`
`static int`	`VERSION_OFFSET`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static FrameDescriptor`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static FrameDescriptor[]`	`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
  - INPUT_OFFSET
```
public static final int INPUT_OFFSET
```
    See Also:
    
    Constant Field Values
  - INPUT_LENGTH
```
public static final int INPUT_LENGTH
```
    See Also:
    
    Constant Field Values
  - TYPE_OFFSET
```
public static final int TYPE_OFFSET
```
    See Also:
    
    Constant Field Values
  - TYPE_LENGTH
```
public static final int TYPE_LENGTH
```
    See Also:
    
    Constant Field Values
  - SEQUENCE_OFFSET
```
public static final int SEQUENCE_OFFSET
```
    See Also:
    
    Constant Field Values
  - SEQUENCE_LENGTH
```
public static final int SEQUENCE_LENGTH
```
    See Also:
    
    Constant Field Values
  - TIME_OFFSET
```
public static final int TIME_OFFSET
```
    See Also:
    
    Constant Field Values
  - TIME_LENGTH
```
public static final int TIME_LENGTH
```
    See Also:
    
    Constant Field Values
  - VERSION_OFFSET
```
public static final int VERSION_OFFSET
```
    See Also:
    
    Constant Field Values
  - VERSION_LENGTH
```
public static final int VERSION_LENGTH
```
    See Also:
    
    Constant Field Values
  - INDEX_OFFSET
```
public static final int INDEX_OFFSET
```
    See Also:
    
    Constant Field Values
  - INDEX_LENGTH
```
public static final int INDEX_LENGTH
```
    See Also:
    
    Constant Field Values
  - PAYLOAD_SIZE_OFFSET
```
public static final int PAYLOAD_SIZE_OFFSET
```
    See Also:
    
    Constant Field Values
  - PAYLOAD_SIZE_LENGTH
```
public static final int PAYLOAD_SIZE_LENGTH
```
    See Also:
    
    Constant Field Values
  - HEADER_OFFSET
```
public static final int HEADER_OFFSET
```
    See Also:
    
    Constant Field Values
  - HEADER_LENGTH
```
public static final int HEADER_LENGTH
```
    See Also:
    
    Constant Field Values
  - PAYLOAD_OFFSET
```
public static final int PAYLOAD_OFFSET
```
    See Also:
    
    Constant Field Values
- Method Detail
  - values
```
public static FrameDescriptor[] 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 (FrameDescriptor c : FrameDescriptor.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static FrameDescriptor 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

Enum FrameDescriptor

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Field Detail

INPUT_OFFSET

INPUT_LENGTH

TYPE_OFFSET

TYPE_LENGTH

SEQUENCE_OFFSET

SEQUENCE_LENGTH

TIME_OFFSET

TIME_LENGTH

VERSION_OFFSET

VERSION_LENGTH

INDEX_OFFSET

INDEX_LENGTH

PAYLOAD_SIZE_OFFSET

PAYLOAD_SIZE_LENGTH

HEADER_OFFSET

HEADER_LENGTH

PAYLOAD_OFFSET

Method Detail

values

valueOf