org.jnetstream.packet.format
Enum FieldFormatString

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FieldFormatString>, FormatString<FieldGetter>

public enum FieldFormatString
extends java.lang.Enum<FieldFormatString>
implements FormatString<FieldGetter>

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

Author:

Mark Bednarczyk, Sly Technologies, Inc.

Enum Constant Summary

FieldName

MultiLineValue

SubFieldUniLineValue

UniLineValue

Method Summary

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

FieldName

public static final FieldFormatString FieldName

MultiLineValue

public static final FieldFormatString MultiLineValue

UniLineValue

public static final FieldFormatString UniLineValue

SubFieldUniLineValue

public static final FieldFormatString SubFieldUniLineValue

Method Detail

values

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

Returns:

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

valueOf

public static FieldFormatString 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<FieldGetter>

Returns:

the defaultString

getGetters

public final FieldGetter[] getGetters()

Specified by:

getGetters in interface FormatString<FieldGetter>

Returns:

the getters