org.jnetpcap.packet.format
Class XmlFormatter

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

public class XmlFormatter
extends JFormatter

This formatter products XML output for a packet. A packet content is output as XML sheet based on field objects read from each header within a packet.

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

XmlFormatter()
Instantiates a new xml formatter.

XmlFormatter(java.lang.Appendable out)
Instantiates a new xml formatter.

XmlFormatter(java.lang.StringBuilder out)
Instantiates a new xml formatter.

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) Called as the last step after the header has been formatted.
protected void	headerBefore(JHeader header, JFormatter.Detail detail) Called as the first step before the header has been formatted.
void	packetAfter(JPacket packet, JFormatter.Detail detail) Packet after.
void	packetBefore(JPacket packet, JFormatter.Detail detail) Packet before.
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, packetNull, 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

XmlFormatter

public XmlFormatter()

Instantiates a new xml formatter.

XmlFormatter

public XmlFormatter(java.lang.Appendable out)

Instantiates a new xml formatter.

Parameters:

out - the out

XmlFormatter

public XmlFormatter(java.lang.StringBuilder out)

Instantiates a new xml formatter.

Parameters:

out - the out

Method Detail

fieldAfter

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

Description copied from class: JFormatter

Field after.

Specified by:

fieldAfter in class JFormatter

Parameters:

header -

field -

detail -

Throws:

java.io.IOException

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

Description copied from class: JFormatter

Field before.

Specified by:

fieldBefore in class JFormatter

Parameters:

header -

field -

detail -

Throws:

java.io.IOException

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

Description copied from class: JFormatter

Called as the last step after the header has been formatted.

Specified by:

headerAfter in class JFormatter

Parameters:

header -

detail -

Throws:

java.io.IOException

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

Description copied from class: JFormatter

Called as the first step before the header has been formatted.

Specified by:

headerBefore in class JFormatter

Parameters:

header -

detail -

Throws:

java.io.IOException

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

Description copied from class: JFormatter

Packet after.

Specified by:

packetAfter in class JFormatter

Parameters:

packet -

detail -

Throws:

java.io.IOException

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

Description copied from class: JFormatter

Packet before.

Specified by:

packetBefore in class JFormatter

Parameters:

packet -

detail -

Throws:

java.io.IOException

See Also:

JFormatter.packetBefore(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

Description copied from class: JFormatter

Sub header after.

Specified by:

subHeaderAfter in class JFormatter

Parameters:

header -

subHeader -

detail -

Throws:

java.io.IOException

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

Description copied from class: JFormatter

Sub header before.

Specified by:

subHeaderBefore in class JFormatter

Parameters:

header -

subHeader -

detail -

Throws:

java.io.IOException

See Also:

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