org.jnetstream.packet.format
Enum HeaderFormatString

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HeaderFormatString>, FormatString<HeaderGetter>

public enum HeaderFormatString
extends java.lang.Enum<HeaderFormatString>
implements FormatString<HeaderGetter>

A set of constants that define the various standard strings that may appear as part of header's formatted output. The constants provide their own builtin defaults, which may be overriden in formatters.

Author:

Mark Bednarczyk, Sly Technologies, Inc.

Enum Constant Summary

HeaderName

LongSummary

ShortDescription

ShortSummary

Method Summary

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

LongSummary

public static final HeaderFormatString LongSummary

ShortSummary

public static final HeaderFormatString ShortSummary

ShortDescription

public static final HeaderFormatString ShortDescription

Method Detail

values

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

Returns:

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

valueOf

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

getDefaultString

public final java.lang.String getDefaultString()

Specified by:

getDefaultString in interface FormatString<HeaderGetter>

Returns:

the defaultString

getGetters

public final HeaderGetter[] getGetters()

Specified by:

getGetters in interface FormatString<HeaderGetter>

Returns:

the getters