com.mgz.afp.base

Class StructuredFieldIntroducer

java.lang.Object

com.mgz.afp.base.StructuredFieldIntroducer

public class StructuredFieldIntroducer
extends java.lang.Object

Structured Field Introducer (SFI)
The MO:DCA Structured Field Introducer (SFI) identifies type and length of the structured field.

Constructor Summary

Constructors

Constructor and Description
StructuredFieldIntroducer()

Method Summary

Modifier and Type	Method and Description
AFPParserConfiguration	getActualConfig()
byte[]	getExtensionData()
short	getExtensionLength()
long	getFileOffset() Returns the position in the file where the structured field begins.
java.util.EnumSet<SFFlag>	getFlagByte()
int	getLengthOfStructuredFieldIntroducerIncludingExtension()
int	getReserved()
int	getSFLength()
SFTypeID	getSFTypeID()
boolean	isFlagSet(SFFlag flag)
static StructuredFieldIntroducer	parse(java.io.InputStream is)
void	removeFlag(SFFlag flag)
void	setActualConfig(AFPParserConfiguration actualConfig)
void	setExtensionData(byte[] sfiExtensionData) Sets the SFI extender Data.
void	setFileOffset(long fileOffset)
void	setFlag(SFFlag flag)
void	setFlagByte(java.util.EnumSet<SFFlag> flagByte)
void	setReserved(int reserved)
void	setSFLength(int length)
void	setSFTypeID(SFTypeID sfTypeID)
byte[]	toBytes()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StructuredFieldIntroducer

public StructuredFieldIntroducer()

Method Detail

parse

public static StructuredFieldIntroducer parse(java.io.InputStream is)
                                       throws AFPParserException

Throws:

AFPParserException

toBytes

public byte[] toBytes()
               throws java.io.IOException

Throws:

java.io.IOException

getLengthOfStructuredFieldIntroducerIncludingExtension

public int getLengthOfStructuredFieldIntroducerIncludingExtension()

getSFLength

public int getSFLength()

setSFLength

public void setSFLength(int length)

getExtensionLength

public short getExtensionLength()

getExtensionData

public byte[] getExtensionData()

setExtensionData

public void setExtensionData(byte[] sfiExtensionData)

Sets the SFI extender Data. The corresponding SFFlag.hasExtension flag and size of extender data of SFI is set accordingly. If the given extender data is null, the SFFlag.hasExtension flag is revoked and size of extender data of SFI is set to zero (not used).

getReserved

public int getReserved()

setReserved

public void setReserved(int reserved)

isFlagSet

public boolean isFlagSet(SFFlag flag)

setFlag

public void setFlag(SFFlag flag)

removeFlag

public void removeFlag(SFFlag flag)

getSFTypeID

public SFTypeID getSFTypeID()

setSFTypeID

public void setSFTypeID(SFTypeID sfTypeID)

getFileOffset

public long getFileOffset()

Returns the position in the file where the structured field begins. A structured field begins with the 0x5A byte.

setFileOffset

public void setFileOffset(long fileOffset)

getFlagByte

public java.util.EnumSet<SFFlag> getFlagByte()

setFlagByte

public void setFlagByte(java.util.EnumSet<SFFlag> flagByte)

getActualConfig

public AFPParserConfiguration getActualConfig()

setActualConfig

public void setActualConfig(AFPParserConfiguration actualConfig)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object