io.aeron.archive.codecs

Enum RecordingSignal

java.lang.Object

java.lang.Enum<RecordingSignal>

io.aeron.archive.codecs.RecordingSignal

All Implemented Interfaces:

Serializable, Comparable<RecordingSignal>

public enum RecordingSignal
extends Enum<RecordingSignal>

Signal of operations happening to a recording.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DELETE Recording has deleted segments.
EXTEND Recording has started extending.
MERGE Recording merged with live stream after replay.
NULL_VAL To be used to represent not present or null.
REPLICATE Recording descriptor replicated from source archive.
REPLICATE_END Recording replication has ended.
START Recording has started for a stream.
STOP Recording has stopped for a stream.
SYNC Recording synchronised with source archive.

Method Summary

Modifier and Type	Method and Description
static RecordingSignal	get(int value) Lookup the enum value representing the value.
int	value() The raw encoded value in the Java type representation.
static RecordingSignal	valueOf(String name) Returns the enum constant of this type with the specified name.
static RecordingSignal[]	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

START

public static final RecordingSignal START

Recording has started for a stream.

STOP

public static final RecordingSignal STOP

Recording has stopped for a stream.

EXTEND

public static final RecordingSignal EXTEND

Recording has started extending.

REPLICATE

public static final RecordingSignal REPLICATE

Recording descriptor replicated from source archive.

MERGE

public static final RecordingSignal MERGE

Recording merged with live stream after replay.

SYNC

public static final RecordingSignal SYNC

Recording synchronised with source archive.

DELETE

public static final RecordingSignal DELETE

Recording has deleted segments.

REPLICATE_END

public static final RecordingSignal REPLICATE_END

Recording replication has ended.

NULL_VAL

public static final RecordingSignal NULL_VAL

To be used to represent not present or null.

Method Detail

values

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

Returns:

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

valueOf

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

value

public int value()

The raw encoded value in the Java type representation.

Returns:

the raw value encoded.

get

public static RecordingSignal get(int value)

Lookup the enum value representing the value.

Parameters:

value - encoded to be looked up.

Returns:

the enum value representing the value.