org.jnetstream.packet.format
Enum HeaderOption

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

All Implemented Interfaces:

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

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

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

Author:

Mark Bednarczyk, Sly Technologies, Inc.

Enum Constant Summary

ExpandFields

ExpandHeaders

ExpandProperties

ExpandSubFields

ExpandSubHeaders

HeaderName

LongDescription

LongSummary

ShortDescription

ShortSummary

ShowField

ShowHeader

ShowProperty

ShowSubField

ShowSubHeader

ShowValue

Method Summary

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

ShowValue

public static final HeaderOption ShowValue

ShortDescription

public static final HeaderOption ShortDescription

LongDescription

public static final HeaderOption LongDescription

ShortSummary

public static final HeaderOption ShortSummary

LongSummary

public static final HeaderOption LongSummary

ShowProperty

public static final HeaderOption ShowProperty

ShowHeader

public static final HeaderOption ShowHeader

ShowSubHeader

public static final HeaderOption ShowSubHeader

ShowField

public static final HeaderOption ShowField

ShowSubField

public static final HeaderOption ShowSubField

ExpandHeaders

public static final HeaderOption ExpandHeaders

ExpandSubHeaders

public static final HeaderOption ExpandSubHeaders

ExpandFields

public static final HeaderOption ExpandFields

ExpandSubFields

public static final HeaderOption ExpandSubFields

ExpandProperties

public static final HeaderOption ExpandProperties

Method Detail

values

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

Returns:

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

valueOf

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