com.mgz.afp.base

Class StructuredFieldBaseName

java.lang.Object

com.mgz.afp.base.StructuredField

com.mgz.afp.base.StructuredFieldBaseName

All Implemented Interfaces:

IHasName, IAFPDecodeableWriteable

Direct Known Subclasses:

BCF_BeginCodedFont, BDG_BeginDocumentEnvironmentGroup, BDT_BeginDocument, BDX_BeginDataMapTransmitionSubcase, BFG_BeginFormEnvironmentGroup, BII_BeginIMImageObject, BPM_BeginPageMap, BRS_BeginResource, EAG_EndActiveEnvironmentGroup, EBC_EndBarCodeObject, ECF_EndCodedFont, ECP_EndCodePage, EDG_EndDocumentEnvironmentGroup, EDI_EndDocumentIndex, EDM_EndDataMap, EDT_EndDocument, EDX_EndDataMapTransmitionSubcase, EFG_EndFormEnvironmentGroup, EFM_EndFormMap, EFN_EndFont, EGR_EndGraphicsObject, EII_EndIMImageObject, EIM_EndImageObject, EMM_EndMediumMap, EMO_EndOverlay, ENG_EndNamedPageGroup, EOC_EndObjectContainer, EOG_EndObjectEnvironmentGroup, EPF_EndPrintFile, EPG_EndPage, EPM_EndPageMap, EPS_EndPageSegment, EPT_EndPresentationTextObject, ERG_EndResourceGroup, ERS_EndResource, ESG_EndResourceEnvironmentGroup, IDM_InvokeDataMap, IOB_IncludeObject, StructuredFieldBaseNameAndTriplets

public abstract class StructuredFieldBaseName
extends StructuredField
implements IHasName

The Charset used for de/encoding of the name is provided by AFPParserConfiguration.getAfpCharSet().

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	name

Constructor Summary

Constructors

Constructor and Description
StructuredFieldBaseName()

Method Summary

Modifier and Type	Method and Description
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.lang.String	getName() Returns the name.
void	setName(java.lang.String name) Sets the name.
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

name

protected java.lang.String name

Constructor Detail

StructuredFieldBaseName

public StructuredFieldBaseName()

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.

getName

public final java.lang.String getName()

Description copied from interface: IHasName

Returns the name.

Specified by:

getName in interface IHasName

Returns:

name of this structured field.

setName

public final void setName(java.lang.String name)

Description copied from interface: IHasName

Sets the name.

Specified by:

setName in interface IHasName

Parameters:

name - the name of this structured field