Package org.apache.fop.afp.parser

Class UnparsedStructuredField

java.lang.Object

org.apache.fop.afp.parser.UnparsedStructuredField

public final class UnparsedStructuredField
extends java.lang.Object

Represents an unparsed (generic) AFP structured field.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	UnparsedStructuredField.Introducer

Field Summary

Fields

Modifier and Type	Field	Description
private byte[]	data
private byte[]	extData
private UnparsedStructuredField.Introducer	introducer

Constructor Summary

Constructors

Constructor	Description
UnparsedStructuredField(UnparsedStructuredField.Introducer introducer, byte[] data, byte[] extData)

Method Summary

Modifier and Type	Method	Description
private java.lang.String	getCategoryCodeAsString()	Returns category code function name for this field.
byte[]	getCompleteFieldAsBytes()	Returns the complete structured field as a byte array.
byte[]	getData()	Returns the structured field's payload.
(package private) byte[]	getExtData()	Returns the extension data if present.
short	getExtLength()	Returns the length of the extension if present.
(package private) byte[]	getIntroducerData()
byte	getSfCategoryCode()	Returns the structured field's category code.
byte	getSfClassCode()	Returns the structured field's class code.
short	getSfLength()	Returns the structured field's length.
byte	getSfTypeCode()	Returns the structured field's type code.
int	getSfTypeID()	Returns the structured field's identifier.
private java.lang.String	getTypeCodeAsString()	Returns type code function name for this field.
boolean	isSfiExtensionPresent()	Indicates whether an field introducer extension is present.
boolean	isSfiPaddingPresent()	Indicates whether the data is padded.
boolean	isSfiSegmentedData()	Indicates whether segmented data is present.
java.lang.String	toString()
void	writeTo(java.io.OutputStream out)	Writes this structured field to the given OutputStream.

Methods inherited from class java.lang.Object

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

Field Detail

introducer

private final UnparsedStructuredField.Introducer introducer

extData

private final byte[] extData

data

private final byte[] data

Constructor Detail

UnparsedStructuredField

UnparsedStructuredField(UnparsedStructuredField.Introducer introducer,
                        byte[] data,
                        byte[] extData)

Parameters:

Structured - field introducer

data - Structured field data

extData - Structured field extension data

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getTypeCodeAsString

private java.lang.String getTypeCodeAsString()

Returns type code function name for this field.

Returns:

the type code function name

getCategoryCodeAsString

private java.lang.String getCategoryCodeAsString()

Returns category code function name for this field.

Returns:

the category code function name

getSfLength

public short getSfLength()

Returns the structured field's length.

Returns:

the field length

getSfTypeID

public int getSfTypeID()

Returns the structured field's identifier.

Returns:

the field identifier

getSfClassCode

public byte getSfClassCode()

Returns the structured field's class code.

Returns:

the field class code

getSfTypeCode

public byte getSfTypeCode()

Returns the structured field's type code.

Returns:

the type code

getSfCategoryCode

public byte getSfCategoryCode()

Returns the structured field's category code.

Returns:

the sfCategoryCode

isSfiExtensionPresent

public boolean isSfiExtensionPresent()

Indicates whether an field introducer extension is present.

Returns:

true if an field introducer extension is present

isSfiSegmentedData

public boolean isSfiSegmentedData()

Indicates whether segmented data is present.

Returns:

true if the data is segmented

isSfiPaddingPresent

public boolean isSfiPaddingPresent()

Indicates whether the data is padded.

Returns:

true if the data is padded

getExtLength

public short getExtLength()

Returns the length of the extension if present.

Returns:

the length of the extension (or 0 if no extension is present)

getExtData

byte[] getExtData()

Returns the extension data if present.

Returns:

the extension data (or null if no extension is present)

getData

public byte[] getData()

Returns the structured field's payload.

Returns:

the field's data

getIntroducerData

byte[] getIntroducerData()

getCompleteFieldAsBytes

public byte[] getCompleteFieldAsBytes()

Returns the complete structured field as a byte array.

Returns:

the complete field data

writeTo

public void writeTo(java.io.OutputStream out)
             throws java.io.IOException

Writes this structured field to the given OutputStream.

Parameters:

out - the output stream

Throws:

java.io.IOException - if an I/O error occurs