Package com.eatthepath.noise

Enum Class NoiseHandshake.Role

java.lang.Object

java.lang.Enum<NoiseHandshake.Role>

com.eatthepath.noise.NoiseHandshake.Role

All Implemented Interfaces:

Serializable, Comparable<NoiseHandshake.Role>, Constable

Enclosing class:

NoiseHandshake

public static enum NoiseHandshake.Role
extends Enum<NoiseHandshake.Role>

An enumeration of roles within a Noise handshake.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INITIATOR	Indicates that a party is the initiator of a Noise handshake.
RESPONDER	Indicates that a party is the responder in a Noise handshake.

Method Summary

Modifier and Type	Method	Description
static NoiseHandshake.Role	valueOf(String name)	Returns the enum constant of this class with the specified name.
static NoiseHandshake.Role[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INITIATOR

public static final NoiseHandshake.Role INITIATOR

Indicates that a party is the initiator of a Noise handshake.

RESPONDER

public static final NoiseHandshake.Role RESPONDER

Indicates that a party is the responder in a Noise handshake.

Method Details

values

public static NoiseHandshake.Role[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static NoiseHandshake.Role valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null