com.neeve.ods

Enum IStoreObject.EncodingType

java.lang.Object

java.lang.Enum<IStoreObject.EncodingType>

com.neeve.ods.IStoreObject.EncodingType

All Implemented Interfaces:

Serializable, Comparable<IStoreObject.EncodingType>

Enclosing interface:

IStoreObject

public static enum IStoreObject.EncodingType
extends Enum<IStoreObject.EncodingType>

Defines the various supported encoding types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Custom Signifies the custom user encoding.
Json Signifies the 'JSON' encoding.
Protobuf Signifies the 'protocol buffer' encoding.
Quark Signifies the 'Quark' encoding.
Xbuf Signifies the 'X buffer' encoding.
Xbuf2 Signifies the 'X Buffer 2' encoding.

Method Summary

Modifier and Type	Method and Description
static IStoreObject.EncodingType	fromMessageViewEncoding(int messageViewEncoding) Translates a message view endoding to its corresponding IStoreObject.EncodingType
int	toMessageViewEncoding()
static IStoreObject.EncodingType	valueOf(String name) Returns the enum constant of this type with the specified name.
static IStoreObject.EncodingType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Custom

public static final IStoreObject.EncodingType Custom

Signifies the custom user encoding.

Quark

public static final IStoreObject.EncodingType Quark

Signifies the 'Quark' encoding.

Xbuf

public static final IStoreObject.EncodingType Xbuf

Signifies the 'X buffer' encoding.

Xbuf2

public static final IStoreObject.EncodingType Xbuf2

Signifies the 'X Buffer 2' encoding.

Protobuf

public static final IStoreObject.EncodingType Protobuf

Signifies the 'protocol buffer' encoding.

Json

public static final IStoreObject.EncodingType Json

Signifies the 'JSON' encoding.

Method Detail

values

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

Returns:

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

valueOf

public static IStoreObject.EncodingType 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

toMessageViewEncoding

public final int toMessageViewEncoding()

Returns:

the MessageView encoding constant for the encoding

fromMessageViewEncoding

public static final IStoreObject.EncodingType fromMessageViewEncoding(int messageViewEncoding)

Translates a message view endoding to its corresponding IStoreObject.EncodingType

Parameters:

messageViewEncoding - The translated message encoding