io.aeron.archive.codecs

Enum SourceLocation

java.lang.Object

java.lang.Enum<SourceLocation>

io.aeron.archive.codecs.SourceLocation

All Implemented Interfaces:

Serializable, Comparable<SourceLocation>

public enum SourceLocation
extends Enum<SourceLocation>

Source location for recorded stream.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOCAL Archive is local to driver.
NULL_VAL To be used to represent not present or null.
REMOTE Archive is remote to driver.

Method Summary

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

LOCAL

public static final SourceLocation LOCAL

Archive is local to driver.

REMOTE

public static final SourceLocation REMOTE

Archive is remote to driver.

NULL_VAL

public static final SourceLocation NULL_VAL

To be used to represent not present or null.

Method Detail

values

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

Returns:

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

valueOf

public static SourceLocation 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 SourceLocation get(int value)

Lookup the enum value representing the value.

Parameters:

value - encoded to be looked up.

Returns:

the enum value representing the value.