org.jnetstream.packet.format
Enum PacketOption

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

All Implemented Interfaces:

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

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

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

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

ShowValue

public static final PacketOption ShowValue

ShortDescription

public static final PacketOption ShortDescription

LongDescription

public static final PacketOption LongDescription

ShortSummary

public static final PacketOption ShortSummary

LongSummary

public static final PacketOption LongSummary

ShowProperty

public static final PacketOption ShowProperty

ShowHeader

public static final PacketOption ShowHeader

ShowSubHeader

public static final PacketOption ShowSubHeader

ShowField

public static final PacketOption ShowField

ShowSubField

public static final PacketOption ShowSubField

ExpandHeaders

public static final PacketOption ExpandHeaders

ExpandSubHeaders

public static final PacketOption ExpandSubHeaders

ExpandFields

public static final PacketOption ExpandFields

ExpandSubFields

public static final PacketOption ExpandSubFields

ExpandProperties

public static final PacketOption ExpandProperties

Method Detail

values

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

Returns:

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

valueOf

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