org.jnetstream.packet.format
Enum PacketFormatString

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PacketFormatString>, FormatString<PacketGetter>

public enum PacketFormatString
extends java.lang.Enum<PacketFormatString>
implements FormatString<PacketGetter>

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

Author:

Mark Bednarczyk, Sly Technologies, Inc.

Enum Constant Summary

Id
Id column

LongSummary
Long summary of the packet contents

ShortSummary
Short summary of the packet contents

Method Summary

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

Id

public static final PacketFormatString Id

Id column

LongSummary

public static final PacketFormatString LongSummary

Long summary of the packet contents

ShortSummary

public static final PacketFormatString ShortSummary

Short summary of the packet contents

Method Detail

values

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

Returns:

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

valueOf

public static PacketFormatString 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<PacketGetter>

Returns:

the defaultString

getGetters

public final PacketGetter[] getGetters()

Specified by:

getGetters in interface FormatString<PacketGetter>

Returns:

the getters