com.hp.of.lib.err

Enum ECodeHelloFailed

java.lang.Object

java.lang.Enum<ECodeHelloFailed>

com.hp.of.lib.err.ECodeHelloFailed

All Implemented Interfaces:

ErrorCode, OfpCodeBasedEnum, OfpEnum, Serializable, Comparable<ECodeHelloFailed>

public enum ECodeHelloFailed
extends Enum<ECodeHelloFailed>
implements ErrorCode

Designates the error codes associated with the ErrorType.HELLO_FAILED error type.

Author:

Simon Hunt

Enum Constant Summary

Enum Constants

Enum Constant and Description
EPERM Permissions error; Since 1.0.
INCOMPATIBLE No compatible version; Since 1.0.

Method Summary

Modifier and Type	Method and Description
int	getCode(ProtocolVersion pv) Returns the code for the constant, under the given protocol version.
ErrorType	parentType() Returns the parent error type for this error code.
static void	validate(ECodeHelloFailed code, ProtocolVersion pv) Validates the given error code against the specified protocol version, silently returning if all is well, throwing an exception otherwise.
static ECodeHelloFailed	valueOf(String name) Returns the enum constant of this type with the specified name.
static ECodeHelloFailed[]	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

INCOMPATIBLE

public static final ECodeHelloFailed INCOMPATIBLE

No compatible version; Since 1.0.

EPERM

public static final ECodeHelloFailed EPERM

Permissions error; Since 1.0.

Method Detail

values

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

Returns:

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

valueOf

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

parentType

public ErrorType parentType()

Description copied from interface: ErrorCode

Returns the parent error type for this error code.

Specified by:

parentType in interface ErrorCode

Returns:

the parent error type

getCode

public int getCode(ProtocolVersion pv)

Description copied from interface: OfpCodeBasedEnum

Returns the code for the constant, under the given protocol version.

Specified by:

getCode in interface OfpCodeBasedEnum

Parameters:

pv - the protocol version

Returns:

the code for the constant

validate

public static void validate(ECodeHelloFailed code,
                            ProtocolVersion pv)

Validates the given error code against the specified protocol version, silently returning if all is well, throwing an exception otherwise.

Parameters:

code - the code

pv - the protocol version

Throws:

VersionMismatchException - if the code is not defined in the given protocol version