org.jnetstream.packet.format
Enum FieldOption

java.lang.Object
  java.lang.Enum<FieldOption>
      org.jnetstream.packet.format.FieldOption

All Implemented Interfaces:

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

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

Optional components that can be included as part of the formatted display for a field.

Author:

Mark Bednarczyk, Sly Technologies, Inc.

Enum Constant Summary

ExpandFields

ExpandHeaders

ExpandProperties

ExpandSubFields

ExpandSubHeaders

FieldName

HeaderName

LongDescription

LongSummary

ShortDescription

ShortSummary

ShowField

ShowHeader

ShowProperty

ShowSubField

ShowSubFieldValue

ShowSubHeader

ShowValue

Method Summary

static FieldOption	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FieldOption[]	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

HeaderName

public static final FieldOption HeaderName

FieldName

public static final FieldOption FieldName

ShowValue

public static final FieldOption ShowValue

ShortDescription

public static final FieldOption ShortDescription

LongDescription

public static final FieldOption LongDescription

ShortSummary

public static final FieldOption ShortSummary

LongSummary

public static final FieldOption LongSummary

ShowProperty

public static final FieldOption ShowProperty

ShowHeader

public static final FieldOption ShowHeader

ShowSubHeader

public static final FieldOption ShowSubHeader

ShowField

public static final FieldOption ShowField

ShowSubField

public static final FieldOption ShowSubField

ExpandHeaders

public static final FieldOption ExpandHeaders

ExpandSubHeaders

public static final FieldOption ExpandSubHeaders

ExpandFields

public static final FieldOption ExpandFields

ExpandSubFields

public static final FieldOption ExpandSubFields

ExpandProperties

public static final FieldOption ExpandProperties

ShowSubFieldValue

public static final FieldOption ShowSubFieldValue

Method Detail

values

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

Returns:

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

valueOf

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