com.mgz.afp.base

Class StructuredFieldBaseTriplets

java.lang.Object

com.mgz.afp.base.StructuredField

com.mgz.afp.base.StructuredFieldBaseTriplets

All Implemented Interfaces:

IHasTriplets, IAFPDecodeableWriteable

Direct Known Subclasses:

BDM_BeginDataMap, IEL_IndexElement, IPG_IncludePage, IPO_IncludePageOverlay, IPS_IncludePageSegment, LND_LineDescriptor, MDD_MediumDescriptor, MFC_MediumFinishingControl, OBD_ObjectAreaDescriptor, PEC_PresentationEnvironmentControl, PFC_PresentationFidelityControl, PGD_PageDescriptor, PMC_PageModificationControl, RCD_RecordDescriptor, TLE_TagLogicalElement, XMD_XMLDescriptor

public abstract class StructuredFieldBaseTriplets
extends StructuredField
implements IHasTriplets

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<Triplet>	triplets

Constructor Summary

Constructors

Constructor and Description
StructuredFieldBaseTriplets()

Method Summary

Modifier and Type	Method and Description
void	addTriplet(Triplet triplet) Convenient method to add Triplet to the list of Triplets.
void	decodeAFP(byte[] sfData, int offset, int length, AFPParserConfiguration config) Decodes the given AFP data. Parameter length specifies the length in bytes of the data to be decoded, beginning with position offset.
java.util.List<Triplet>	getTriplets() Returns the list of Triplets.
void	removeTriplet(Triplet triplet) Convenient method to removes the given Triplet to the list of Triplets.
void	setTriplets(java.util.List<Triplet> triplets) Sets the list of Triplets.
void	writeAFP(java.io.OutputStream os, AFPParserConfiguration config) Writes the object to the given os encoded as AFP data.

Methods inherited from class com.mgz.afp.base.StructuredField

checkDataLength, getActualLength, getPadding, getStructuredFieldIntroducer, isBeginSF, isEndSF, isShallow, setPadding, setStructuredFieldIntroducer, toString, writeFullStructuredField

Methods inherited from class java.lang.Object

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

Field Detail

triplets

protected java.util.List<Triplet> triplets

Constructor Detail

StructuredFieldBaseTriplets

public StructuredFieldBaseTriplets()

Method Detail

decodeAFP

public void decodeAFP(byte[] sfData,
                      int offset,
                      int length,
                      AFPParserConfiguration config)
               throws AFPParserException

Description copied from interface: IAFPDecodeableWriteable

Decodes the given AFP data.
Parameter length specifies the length in bytes of the data to be decoded, beginning with position offset. If parameter length has a value of -1, the given data array is decoded up to the end of the array.

Specified by:

decodeAFP in interface IAFPDecodeableWriteable

Specified by:

decodeAFP in class StructuredField

Parameters:

sfData - contains the AFP data to decode.

offset - the byte index position where the decoding should start.

length - the length in bytes of the data to be decoded, beginning with position offset.

config - contains parameter used for decoding.

Throws:

AFPParserException - if the given AFP data are invalid.

writeAFP

public void writeAFP(java.io.OutputStream os,
                     AFPParserConfiguration config)
              throws java.io.IOException

Description copied from interface: IAFPDecodeableWriteable

Writes the object to the given os encoded as AFP data.

Specified by:

writeAFP in interface IAFPDecodeableWriteable

Specified by:

writeAFP in class StructuredField

Parameters:

os - OutputStream to write to.

config - contains parameter used for encoding.

Throws:

java.io.IOException - if a problem occurs while writing to the given OutputStream.

getTriplets

public final java.util.List<Triplet> getTriplets()

Description copied from interface: IHasTriplets

Returns the list of Triplets.

Specified by:

getTriplets in interface IHasTriplets

setTriplets

public final void setTriplets(java.util.List<Triplet> triplets)

Description copied from interface: IHasTriplets

Sets the list of Triplets.

Specified by:

setTriplets in interface IHasTriplets

addTriplet

public final void addTriplet(Triplet triplet)

Description copied from interface: IHasTriplets

Convenient method to add Triplet to the list of Triplets.

Specified by:

addTriplet in interface IHasTriplets

Parameters:

triplet - Triplet to add.

removeTriplet

public final void removeTriplet(Triplet triplet)

Description copied from interface: IHasTriplets

Convenient method to removes the given Triplet to the list of Triplets.

Specified by:

removeTriplet in interface IHasTriplets

Parameters:

triplet - Triplet to remove.