org.jnetpcap.packet
Class JMappedHeader

java.lang.Object
  extended by org.jnetpcap.nio.JMemory
      extended by org.jnetpcap.nio.JBuffer
          extended by org.jnetpcap.packet.JHeader
              extended by org.jnetpcap.packet.JMappedHeader
All Implemented Interfaces:
JPayloadAccessor
Direct Known Subclasses:
AbstractMessageHeader, Sdp

public class JMappedHeader
extends JHeader

The Class JMappedHeader.

Author:
Mark Bednarczyk, Sly Technologies, Inc.

Nested Class Summary
 
Nested classes/interfaces inherited from class org.jnetpcap.packet.JHeader
JHeader.State
 
Nested classes/interfaces inherited from class org.jnetpcap.nio.JMemory
JMemory.Type
 
Field Summary
 
Fields inherited from class org.jnetpcap.packet.JHeader
annotatedHeader, BYTE, EMPTY_HEADER_ARRAY, isSubHeader, packet, state
 
Fields inherited from class org.jnetpcap.nio.JMemory
JNETPCAP_LIBRARY_NAME, MAX_DIRECT_MEMORY_DEFAULT, POINTER
 
Constructor Summary
JMappedHeader()
          Instantiates a new j mapped header.
JMappedHeader(int id, JField[] fields, java.lang.String name)
          Instantiates a new j mapped header.
JMappedHeader(int id, JField[] fields, java.lang.String name, java.lang.String nicname)
          Instantiates a new j mapped header.
JMappedHeader(int id, java.lang.String name)
          Instantiates a new j mapped header.
JMappedHeader(int id, java.lang.String name, java.lang.String nicname)
          Instantiates a new j mapped header.
JMappedHeader(JHeader.State state, JField[] fields, java.lang.String name, java.lang.String nicname)
          Instantiates a new j mapped header.
JMappedHeader(JProtocol protocol)
          Instantiates a new j mapped header.
 
Method Summary
 void addField(java.lang.Enum<? extends java.lang.Enum<?>> field, java.lang.String value, int offset)
          Adds the field.
 void addField(java.lang.Enum<? extends java.lang.Enum<?>> field, java.lang.String value, int offset, int length)
          Adds the field.
 void addField(java.lang.String name, java.lang.String value, int offset, int length)
          Adds the field.
 void clearFields()
          Clear fields.
 java.lang.String[] fieldArray()
          Field array.
protected  java.lang.String fieldDescription(java.lang.Enum<? extends java.lang.Enum<?>> field)
          Field description.
protected  java.lang.String fieldDescription(java.lang.String field)
          Field description.
protected  java.lang.String fieldDisplay(java.lang.Enum<? extends java.lang.Enum<?>> field)
          Field display.
protected  java.lang.String fieldDisplay(java.lang.String field)
          Field display.
protected  int fieldLength(java.lang.Enum<? extends java.lang.Enum<?>> field)
          Field length.
protected  int fieldLength(java.lang.String field)
          Field length.
protected  int fieldOffset(java.lang.Enum<? extends java.lang.Enum<?>> field)
          Field offset.
protected  int fieldOffset(java.lang.String field)
          Field offset.
protected
<V> V
fieldValue(java.lang.Class<V> c, java.lang.Enum<? extends java.lang.Enum<?>> field)
          Field value.
protected
<V> V
fieldValue(java.lang.Class<V> c, java.lang.String field)
          Field value.
protected  java.lang.Object fieldValue(java.lang.Enum<? extends java.lang.Enum<?>> field)
          Field value.
protected  java.lang.Object fieldValue(java.lang.String field)
          Field value.
protected  boolean hasField(java.lang.Enum<? extends java.lang.Enum<?>> field)
          Checks for field.
protected  boolean hasField(java.lang.String field)
          Checks for field.
protected  java.lang.String map(java.lang.Enum<? extends java.lang.Enum<?>> field)
          Map.
protected  java.lang.String map(java.lang.String field)
          Map.
 
Methods inherited from class org.jnetpcap.packet.JHeader
decode, decodeHeader, getAnnotatedHeader, getDescription, getFields, getGap, getGapLength, getGapOffset, getHeader, getHeaderLength, getHeaderOffset, getId, getIndex, getLength, getName, getNextHeaderId, getNextHeaderOffset, getNicname, getOffset, getPacket, getParent, getPayload, getPayloadLength, getPayloadOffset, getPostfix, getPostfixLength, getPostfixOffset, getPrefix, getPrefixLength, getPrefixOffset, getPreviousHeaderId, getPreviousHeaderOffset, getState, getSubHeaders, hasDescription, hasGap, hasNextHeader, hasPayload, hasPostfix, hasPrefix, hasPreviousHeader, hasSubHeaders, isFragmented, isGapTruncated, isHeaderTruncated, isPayloadTruncated, isPostfixTruncated, isPrefixTruncated, peer, peer, peerPayloadTo, setPacket, setSubHeaders, sizeof, toString, transferPayloadTo, transferPayloadTo, transferPayloadTo, validateHeader
 
Methods inherited from class org.jnetpcap.nio.JBuffer
findUTF8String, getByte, getByteArray, getByteArray, getByteArray, getDouble, getFloat, getInt, getLong, getShort, getUByte, getUInt, getUShort, getUTF8Char, getUTF8String, getUTF8String, getUTF8String, getUTF8String, isReadonly, order, order, peer, peer, peer, peer, setByte, setByteArray, setByteBuffer, setDouble, setFloat, setInt, setLong, setShort, setShort0, setUByte, setUInt, setUShort, transferFrom, transferFrom, transferFrom, transferTo, transferTo, transferTo
 
Methods inherited from class org.jnetpcap.nio.JMemory
availableDirectMemory, check, cleanup, createReference, isInitialized, isJMemoryBasedOwner, isOwner, maxDirectMemory, peer, reservedDirectMemory, setSize, size, softDirectMemory, toDebugString, toHexdump, toHexdump, totalActiveAllocated, totalAllocateCalls, totalAllocated, totalAllocatedSegments0To255Bytes, totalAllocatedSegments256OrAbove, totalDeAllocateCalls, totalDeAllocated, transferFrom, transferFrom, transferFromDirect, transferOwnership, transferTo, transferTo, transferTo, transferTo, transferTo, transferTo0
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JMappedHeader

public JMappedHeader()
Instantiates a new j mapped header.


JMappedHeader

public JMappedHeader(JProtocol protocol)
Instantiates a new j mapped header.

Parameters:
protocol - the protocol

JMappedHeader

public JMappedHeader(int id,
                     JField[] fields,
                     java.lang.String name)
Instantiates a new j mapped header.

Parameters:
id - the id
fields - the fields
name - the name

JMappedHeader

public JMappedHeader(int id,
                     JField[] fields,
                     java.lang.String name,
                     java.lang.String nicname)
Instantiates a new j mapped header.

Parameters:
id - the id
fields - the fields
name - the name
nicname - the nicname

JMappedHeader

public JMappedHeader(int id,
                     java.lang.String name)
Instantiates a new j mapped header.

Parameters:
id - the id
name - the name

JMappedHeader

public JMappedHeader(int id,
                     java.lang.String name,
                     java.lang.String nicname)
Instantiates a new j mapped header.

Parameters:
id - the id
name - the name
nicname - the nicname

JMappedHeader

public JMappedHeader(JHeader.State state,
                     JField[] fields,
                     java.lang.String name,
                     java.lang.String nicname)
Instantiates a new j mapped header.

Parameters:
state - the state
fields - the fields
name - the name
nicname - the nicname
Method Detail

hasField

protected boolean hasField(java.lang.Enum<? extends java.lang.Enum<?>> field)
Checks for field.

Parameters:
field - the field
Returns:
true, if successful

hasField

@Dynamic(value=CHECK)
protected boolean hasField(java.lang.String field)
Checks for field.

Parameters:
field - the field
Returns:
true, if successful

fieldDescription

protected java.lang.String fieldDescription(java.lang.Enum<? extends java.lang.Enum<?>> field)
Field description.

Parameters:
field - the field
Returns:
the string

fieldDescription

@Dynamic(value=DESCRIPTION)
protected java.lang.String fieldDescription(java.lang.String field)
Field description.

Parameters:
field - the field
Returns:
the string

fieldDisplay

protected java.lang.String fieldDisplay(java.lang.Enum<? extends java.lang.Enum<?>> field)
Field display.

Parameters:
field - the field
Returns:
the string

fieldDisplay

@Dynamic(value=DISPLAY)
protected java.lang.String fieldDisplay(java.lang.String field)
Field display.

Parameters:
field - the field
Returns:
the string

fieldLength

protected int fieldLength(java.lang.Enum<? extends java.lang.Enum<?>> field)
Field length.

Parameters:
field - the field
Returns:
the int

fieldLength

@Dynamic(value=LENGTH)
protected int fieldLength(java.lang.String field)
Field length.

Parameters:
field - the field
Returns:
the int

fieldOffset

protected int fieldOffset(java.lang.Enum<? extends java.lang.Enum<?>> field)
Field offset.

Parameters:
field - the field
Returns:
the int

map

protected java.lang.String map(java.lang.Enum<? extends java.lang.Enum<?>> field)
Map.

Parameters:
field - the field
Returns:
the string

map

protected java.lang.String map(java.lang.String field)
Map.

Parameters:
field - the field
Returns:
the string

fieldOffset

@Dynamic(value=OFFSET)
protected int fieldOffset(java.lang.String field)
Field offset.

Parameters:
field - the field
Returns:
the int

fieldValue

protected java.lang.Object fieldValue(java.lang.Enum<? extends java.lang.Enum<?>> field)
Field value.

Parameters:
field - the field
Returns:
the object

fieldValue

@Dynamic(value=VALUE)
protected java.lang.Object fieldValue(java.lang.String field)
Field value.

Parameters:
field - the field
Returns:
the object

fieldValue

protected <V> V fieldValue(java.lang.Class<V> c,
                           java.lang.Enum<? extends java.lang.Enum<?>> field)
Field value.

Type Parameters:
V - the value type
Parameters:
c - the c
field - the field
Returns:
the v

fieldValue

protected <V> V fieldValue(java.lang.Class<V> c,
                           java.lang.String field)
Field value.

Type Parameters:
V - the value type
Parameters:
c - the c
field - the field
Returns:
the v

fieldArray

public java.lang.String[] fieldArray()
Field array.

Returns:
the string[]

addField

public void addField(java.lang.Enum<? extends java.lang.Enum<?>> field,
                     java.lang.String value,
                     int offset)
Adds the field.

Parameters:
field - the field
value - the value
offset - the offset

addField

public void addField(java.lang.Enum<? extends java.lang.Enum<?>> field,
                     java.lang.String value,
                     int offset,
                     int length)
Adds the field.

Parameters:
field - the field
value - the value
offset - the offset
length - the length

addField

public void addField(java.lang.String name,
                     java.lang.String value,
                     int offset,
                     int length)
Adds the field.

Parameters:
name - the name
value - the value
offset - the offset
length - the length

clearFields

public void clearFields()
Clear fields.