org.jnetstream.packet
Enum Header.StaticProperty

java.lang.Object
  java.lang.Enum<Header.StaticProperty>
      org.jnetstream.packet.Header.StaticProperty

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Header.StaticProperty>

Enclosing interface:

Header

public static enum Header.StaticProperty
extends java.lang.Enum<Header.StaticProperty>

Constants which define various automatic and user defined properties. These properties are exported by CODECs as well as set directly by the source NPL definition itself.

Author:

Mark Bednarczyk, Sly Technologies, Inc.

Enum Constant Summary

Characteristics
Frame and physical characteristics of this header.

Common
A label that is a more common name for this header.

Description

Init
Special property that is used to initialize fields when packet is created from memory.

LongSummary

OSILayer
The OSI layer of this header.

ShortHeader
Another even shorter header that summarizes even more tersly the contents of this header.

ShortSummary

Summary
Header summary line that summarizes the most important field values on 1 lines, as short as possible.

Method Summary

java.lang.Class<?>	getValueType() Returns the class that must be used to hold the value of this property
boolean	isStatic() Tells if this property is a static property or dynamic.
static Header.StaticProperty	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Header.StaticProperty[]	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

Init

public static final Header.StaticProperty Init

Special property that is used to initialize fields when packet is created from memory. Type PacketInitializer.class

Characteristics

public static final Header.StaticProperty Characteristics

Frame and physical characteristics of this header. Type Set.class.

Common

public static final Header.StaticProperty Common

A label that is a more common name for this header. This name is usually very short compared to the full name of a prototocol header. Type Type String.class.

OSILayer

public static final Header.StaticProperty OSILayer

The OSI layer of this header. Type OSILayer.class.

Summary

public static final Header.StaticProperty Summary

Header summary line that summarizes the most important field values on 1 lines, as short as possible. Type String.class.

ShortHeader

public static final Header.StaticProperty ShortHeader

Another even shorter header that summarizes even more tersly the contents of this header. Type String.class.

LongSummary

public static final Header.StaticProperty LongSummary

ShortSummary

public static final Header.StaticProperty ShortSummary

Description

public static final Header.StaticProperty Description

Method Detail

values

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

Returns:

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

valueOf

public static Header.StaticProperty 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

getValueType

public java.lang.Class<?> getValueType()

Returns the class that must be used to hold the value of this property

Returns:

class object of the value type

isStatic

public boolean isStatic()

Tells if this property is a static property or dynamic. A static property is defined once for all instances of a header of this type. A dynamic property that exists per instance of a header of this type.

Returns:

true means that there is only a single instance of this property for a header of this type, otherwise the property is dynamic