org.jnetstream.packet.format
Enum FormatterType

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

All Implemented Interfaces:

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

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

Default supplied format types for formatting packet contents for textual output.

Author:

Mark Bednarczyk, Sly Technologies, Inc.

Enum Constant Summary

Plain
Textual formatter that formats packet content for plain output.

Method Summary

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

Plain

public static final FormatterType Plain

Textual formatter that formats packet content for plain output. The full verbose output displays:

• Packet summary line
• First column of output contains the current header name
• Second column contains nicely aligned field names and values of all the fields within a header
• If a field has a subfield, that subfields are output to a 3rd column that aligns the subfield output below the summary line of the parent field.
• ... and so on for each header, field and subfield

Method Detail

values

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

Returns:

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

valueOf

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