Ice

Enum OptionalFormat

java.lang.Object

java.lang.Enum<OptionalFormat>

Ice.OptionalFormat

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OptionalFormat>

public enum OptionalFormat
extends java.lang.Enum<OptionalFormat>

The optional type. An optional value is encoded with a specific optional format. This optional format describes how the data is encoded and how it can be skipped by the unmarshaling code if the optional is not known to the receiver.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Class
F1
F2
F4
F8
FSize
Size
VSize

Method Summary

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

F1

public static final OptionalFormat F1

F2

public static final OptionalFormat F2

F4

public static final OptionalFormat F4

F8

public static final OptionalFormat F8

Size

public static final OptionalFormat Size

VSize

public static final OptionalFormat VSize

FSize

public static final OptionalFormat FSize

Class

public static final OptionalFormat Class

Method Detail

values

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

Returns:

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

valueOf

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

java.lang.NullPointerException - if the argument is null

value

public int value()

valueOf

public static OptionalFormat valueOf(int v)