org.snf4j.core.engine

Enum Status

java.lang.Object

java.lang.Enum<Status>

org.snf4j.core.engine.Status

All Implemented Interfaces:

Serializable, Comparable<Status>

public enum Status
extends Enum<Status>

An enum describing the overall result of the wrap and unwrap methods in an IEngine implementation.

Author:

SNF4J.ORG

Enum Constant Summary

Enum Constants

Enum Constant and Description
BUFFER_OVERFLOW An IEngine implementation was not able to process the operation because there are not enough bytes available in the destination buffer to hold the result.
BUFFER_UNDERFLOW An IEngine implementation was not able to unwrap the incoming data because there were not enough source bytes available to make a complete packet.
CLOSED The operation just closed this side of an IEngine implementation, or the operation could not be completed because it was already closed.
OK An IEngine implementation completed the operation, and is available to process similar calls.

Method Summary

Modifier and Type	Method and Description
static Status	valueOf(String name) Returns the enum constant of this type with the specified name.
static Status[]	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

BUFFER_OVERFLOW

public static final Status BUFFER_OVERFLOW

An IEngine implementation was not able to process the operation because there are not enough bytes available in the destination buffer to hold the result.

BUFFER_UNDERFLOW

public static final Status BUFFER_UNDERFLOW

An IEngine implementation was not able to unwrap the incoming data because there were not enough source bytes available to make a complete packet.

CLOSED

public static final Status CLOSED

The operation just closed this side of an IEngine implementation, or the operation could not be completed because it was already closed.

OK

public static final Status OK

An IEngine implementation completed the operation, and is available to process similar calls.

Method Detail

values

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

Returns:

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

valueOf

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