org.jnetstream.protocol.codec
Enum Codec.Characteristic

java.lang.Object
  java.lang.Enum<Codec.Characteristic>
      org.jnetstream.protocol.codec.Codec.Characteristic

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Codec.Characteristic>

Enclosing interface:

Codec

public static enum Codec.Characteristic
extends java.lang.Enum<Codec.Characteristic>

Describe certain characteristics of a codec.

Author:

Mark Bednarczyk, Sly Technologies, Inc.

Enum Constant Summary

CrossCompiled
Codec that was generated from an NPL definition.

Interpreted
Codec has been implemented as an intepreter of the protocol definition.

Java
A custom codec has been implemented in pure java.

Native
Codec has been implemented natively in "machine code".

Method Summary

static Codec.Characteristic	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Codec.Characteristic[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Native

public static final Codec.Characteristic Native

Codec has been implemented natively in "machine code". The protocol implementation is in machine native code and the implementation uses java JNI interface to access its services.

Java

public static final Codec.Characteristic Java

A custom codec has been implemented in pure java. The protocol definition is encoded in java code and not interpreted.

CrossCompiled

public static final Codec.Characteristic CrossCompiled

Codec that was generated from an NPL definition. This type of codec is generated directly from an NPL definition by special NPL compiler that emmits java code to do exactly what the NPL definition describes.

Interpreted

public static final Codec.Characteristic Interpreted

Codec has been implemented as an intepreter of the protocol definition.

Method Detail

values

public static final Codec.Characteristic[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(Codec.Characteristic c : Codec.Characteristic.values())
        System.out.println(c);

Returns:

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

valueOf

public static Codec.Characteristic valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name