org.jnetpcap.packet.format
Class TextFormatter

java.lang.Object
  org.jnetpcap.packet.format.JFormatter
      org.jnetpcap.packet.format.TextFormatter

public class TextFormatter
extends JFormatter

Formatter that formats packet content for human readable output. This class produces pretty text based output by reading field objects from the header.

Author:

Mark Bednarczyk, Sly Technologies, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class org.jnetpcap.packet.format.JFormatter

JFormatter.Detail, JFormatter.Priority, JFormatter.Style

Field Summary

Fields inherited from class org.jnetpcap.packet.format.JFormatter

frameIndex, out

Constructor Summary

TextFormatter()
Instantiates a new text formatter.

TextFormatter(java.lang.Appendable out)
Creates a test formatter which send its output to an appendable output device.

TextFormatter(java.lang.StringBuilder out)
Creates a text formatter which sends its output to a string buffer.

Method Summary

protected void	fieldAfter(JHeader header, JField field, JFormatter.Detail detail) Field after.
protected void	fieldBefore(JHeader header, JField field, JFormatter.Detail detail) Field before.
protected void	headerAfter(JHeader header, JFormatter.Detail detail) Header after.
protected void	headerBefore(JHeader header, JFormatter.Detail detail) Header before.
void	packetAfter(JPacket packet, JFormatter.Detail detail) Packet after.
void	packetBefore(JPacket packet, JFormatter.Detail detail) Packet before.
protected void	packetNull(JPacket packet, JFormatter.Detail detail) Packet null.
protected void	subHeaderAfter(JHeader header, JHeader subHeader, JFormatter.Detail detail) Sub header after.
protected void	subHeaderBefore(JHeader header, JHeader subHeader, JFormatter.Detail detail) Sub header before.

Methods inherited from class org.jnetpcap.packet.format.JFormatter

decLevel, fieldNull, format, format, format, format, format, format, format, format, getDefault, headerNull, incLevel, incLevel, incLevel, pad, printf, println, reset, setDefault, setDefaultDisplayPayload, setDefaultResolveAddress, setDetail, setDetail, setDisplayPayload, setFrameIndex, setOutput, setOutput, setResolveAddresses, stylizeMultiLine, stylizeMultiLine, stylizeSingleLine, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TextFormatter

public TextFormatter()

Instantiates a new text formatter.

TextFormatter

public TextFormatter(java.lang.Appendable out)

Creates a test formatter which send its output to an appendable output device.

Parameters:

out - where to send output

TextFormatter

public TextFormatter(java.lang.StringBuilder out)

Creates a text formatter which sends its output to a string buffer.

Parameters:

out - buffer where to send output

Method Detail

fieldAfter

protected void fieldAfter(JHeader header,
                          JField field,
                          JFormatter.Detail detail)
                   throws java.io.IOException

Field after.

Specified by:

fieldAfter in class JFormatter

Parameters:

header - the header

field - the field

detail - the detail

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

See Also:

JFormatter.fieldAfter(org.jnetpcap.packet.JHeader, org.jnetpcap.packet.structure.JField, org.jnetpcap.packet.format.JFormatter.Detail)

fieldBefore

protected void fieldBefore(JHeader header,
                           JField field,
                           JFormatter.Detail detail)
                    throws java.io.IOException

Field before.

Specified by:

fieldBefore in class JFormatter

Parameters:

header - the header

field - the field

detail - the detail

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

See Also:

JFormatter.fieldBefore(org.jnetpcap.packet.JHeader, org.jnetpcap.packet.structure.JField, org.jnetpcap.packet.format.JFormatter.Detail)

headerAfter

protected void headerAfter(JHeader header,
                           JFormatter.Detail detail)
                    throws java.io.IOException

Header after.

Specified by:

headerAfter in class JFormatter

Parameters:

header - the header

detail - the detail

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

See Also:

JFormatter.headerAfter(org.jnetpcap.packet.JHeader, org.jnetpcap.packet.format.JFormatter.Detail)

headerBefore

protected void headerBefore(JHeader header,
                            JFormatter.Detail detail)
                     throws java.io.IOException

Header before.

Specified by:

headerBefore in class JFormatter

Parameters:

header - the header

detail - the detail

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

See Also:

JFormatter.headerBefore(org.jnetpcap.packet.JHeader, org.jnetpcap.packet.format.JFormatter.Detail)

packetAfter

public void packetAfter(JPacket packet,
                        JFormatter.Detail detail)
                 throws java.io.IOException

Packet after.

Specified by:

packetAfter in class JFormatter

Parameters:

packet - the packet

detail - the detail

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

See Also:

JFormatter.packetAfter(org.jnetpcap.packet.JPacket, org.jnetpcap.packet.format.JFormatter.Detail)

packetBefore

public void packetBefore(JPacket packet,
                         JFormatter.Detail detail)
                  throws java.io.IOException

Packet before.

Specified by:

packetBefore in class JFormatter

Parameters:

packet - the packet

detail - the detail

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

See Also:

JFormatter.packetBefore(org.jnetpcap.packet.JPacket, org.jnetpcap.packet.format.JFormatter.Detail)

packetNull

protected void packetNull(JPacket packet,
                          JFormatter.Detail detail)

Packet null.

Overrides:

packetNull in class JFormatter

Parameters:

packet - the packet

detail - the detail

See Also:

JFormatter.packetNull(org.jnetpcap.packet.JPacket, org.jnetpcap.packet.format.JFormatter.Detail)

subHeaderAfter

protected void subHeaderAfter(JHeader header,
                              JHeader subHeader,
                              JFormatter.Detail detail)
                       throws java.io.IOException

Sub header after.

Specified by:

subHeaderAfter in class JFormatter

Parameters:

header - the header

subHeader - the sub header

detail - the detail

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

See Also:

JFormatter.subHeaderAfter(org.jnetpcap.packet.JHeader, org.jnetpcap.packet.JHeader, org.jnetpcap.packet.format.JFormatter.Detail)

subHeaderBefore

protected void subHeaderBefore(JHeader header,
                               JHeader subHeader,
                               JFormatter.Detail detail)
                        throws java.io.IOException

Sub header before.

Specified by:

subHeaderBefore in class JFormatter

Parameters:

header - the header

subHeader - the sub header

detail - the detail

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

See Also:

JFormatter.subHeaderBefore(org.jnetpcap.packet.JHeader, org.jnetpcap.packet.JHeader, org.jnetpcap.packet.format.JFormatter.Detail)