org.jnetstream.packet.format
Enum SubFieldFormatString

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SubFieldFormatString>, FormatString<SubFieldGetter>

public enum SubFieldFormatString
extends java.lang.Enum<SubFieldFormatString>
implements FormatString<SubFieldGetter>

A set of constants that define the various standard strings that may appear as part of sub field'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

MultiLineValue

SubFieldUniLineValue

UniLineValue

Method Summary

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

MultiLineValue

public static final SubFieldFormatString MultiLineValue

UniLineValue

public static final SubFieldFormatString UniLineValue

SubFieldUniLineValue

public static final SubFieldFormatString SubFieldUniLineValue

Method Detail

values

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

Returns:

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

valueOf

public static SubFieldFormatString 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<SubFieldGetter>

Returns:

the defaultString

getGetters

public final SubFieldGetter[] getGetters()

Specified by:

getGetters in interface FormatString<SubFieldGetter>

Returns:

the getters