AFPParserConfiguration (alpheusafpparser 0.2.2 API)

java.lang.Object
- com.mgz.afp.parser.AFPParserConfiguration

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class AFPParserConfiguration
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
```
The AFPParserConfiguration is used to configure the AFPParser, see AFPParser.AFPParser(AFPParserConfiguration).

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected boolean isParserOwnsInputStream

Fields
Modifier and Type	Field and Description
`protected boolean`	`isParserOwnsInputStream`

Constructor Summary

Constructors
Constructor and Description

AFPParserConfiguration()

Constructors
Constructor and Description
`AFPParserConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AFPParserConfiguration`	`clone()`
`java.nio.charset.Charset`	`getAfpCharSet()` Returns the `Charset` used to decode text contained in the AFP data stream (e.g.
`java.io.File`	`getAFPFile()`
`int`	`getBufferSize()` Returns the size of input buffer used by the parser.
`BDD_BarCodeDataDescriptor`	`getCurrentBarCodeDataDescriptor()`
`CPC_CodePageControl`	`getCurrentCodePageControl()`
`CPD_CodePageDescriptor`	`getCurrentCodePageDescriptor()`
`CPD_CodePageDescriptor`	`getCurrentCPD_CodePageDescriptor()`
`FNC_FontControl`	`getCurrentFontControl()`
`CPC_CodePageControl`	`getCurrentPageControl()`
`java.io.InputStream`	`getInputStream()` Returns the `InputStream` from where the parser reads the AFP data stream.
`boolean`	`isBuildShallow()` Returns true if the parser is building shallow `StructuredField`s.
`boolean`	`isEscalateParsingErrors()`
`boolean`	`isParseToStructuredFieldsBaseData()` Returns true if the parser decodes structured fields of type `StructuredFieldBaseData` and the payload of the structured field is seen as blackbox and not further processed by the parser.
`void`	`resetCurrentAFPObjects()` Resets all preserved AFP objects that are needed by the parser for later reference to null.
`void`	`setAfpCharSet(java.nio.charset.Charset afpCharSet)` Sets the `Charset` used to decode text contained in the AFP data stream (e.g.
`void`	`setAFPFile(java.io.File afpFile)`
`void`	`setBufferSize(int bufferSize)` Sets the size of input buffer used by the parser.
`void`	`setBuildShallow(boolean isBuildShallow)` If set to true the parser is building shallow `StructuredField`s.
`void`	`setCurrentBarCodeDataDescriptor(BDD_BarCodeDataDescriptor currentBarCodeDataDescriptor)`
`void`	`setCurrentCodePageDescriptor(CPD_CodePageDescriptor currentCodePageDescriptor)`
`void`	`setCurrentFontControl(FNC_FontControl fontControl)`
`void`	`setCurrentPageControl(CPC_CodePageControl currentPageControl)`
`void`	`setEscalateParsingErrors(boolean escalateParsingErrors)` If set to true (default) and a parsing error occurs, an `AFPParserException` is thrown that carries the erroneous structured field as an `StructuredFieldErrornouslyBuilt`.
`void`	`setInputStream(java.io.InputStream inputStream)` Sets the `InputStream` from where the parser reads the AFP data stream.
`void`	`setParseToStructuredFieldsBaseData(boolean isParseToStructuredFieldsBaseData)` If set to true the parser produces structured fields of type `StructuredFieldBaseData`.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - isParserOwnsInputStream
```
protected boolean isParserOwnsInputStream
```
- Constructor Detail
  - AFPParserConfiguration
```
public AFPParserConfiguration()
```
- Method Detail
  - getAfpCharSet
```
public java.nio.charset.Charset getAfpCharSet()
```
    Returns the Charset used to decode text contained in the AFP data stream (e.g. PTX,NOP,TLE).
    
    Returns:
    
    Charset used in the AFP data stream.
  - setAfpCharSet
```
public void setAfpCharSet(java.nio.charset.Charset afpCharSet)
```
    Sets the Charset used to decode text contained in the AFP data stream (e.g. PTX,NOP,TLE).
    
    Parameters:
    
    afpCharSet - Charset used in the AFP data stream.
  - getBufferSize
```
public int getBufferSize()
```
    Returns the size of input buffer used by the parser.
    
    Returns:
    
    size of input file buffer used by the parser.
  - setBufferSize
```
public void setBufferSize(int bufferSize)
```
    Sets the size of input buffer used by the parser. Has influence on performance. Default is 500KB. Minimum is 100KB. A higher value can result in higher performance of the parser.
    
    Parameters:
    
    bufferSize - size of input file buffer used by the parser.
  - getInputStream
```
public java.io.InputStream getInputStream()
                                   throws java.io.IOException
```
    Returns the InputStream from where the parser reads the AFP data stream. If no input stream is set this method tries to open the configured AFP file (see setAFPFile(File)) as buffered input stream.
    
    Returns:
    
    the InputStream from where the parser reads the AFP data stream.
    
    Throws:
    
    java.io.IOException - if the input stream is not set and the opening of the configured AFP file could not be opened.
  - setInputStream
```
public void setInputStream(java.io.InputStream inputStream)
```
    Sets the InputStream from where the parser reads the AFP data stream.
    
    Parameters:
    
    inputStream - the InputStream from where the parser reads the AFP data stream.
  - getCurrentFontControl
```
public FNC_FontControl getCurrentFontControl()
```
  - setCurrentFontControl
```
public void setCurrentFontControl(FNC_FontControl fontControl)
```
  - isParseToStructuredFieldsBaseData
```
public boolean isParseToStructuredFieldsBaseData()
```
    Returns true if the parser decodes structured fields of type StructuredFieldBaseData and the payload of the structured field is seen as blackbox and not further processed by the parser.
    
    Returns:
    
    true if the parser generates StructuredFieldBaseData.
  - setParseToStructuredFieldsBaseData
```
public void setParseToStructuredFieldsBaseData(boolean isParseToStructuredFieldsBaseData)
```
    If set to true the parser produces structured fields of type StructuredFieldBaseData. StructuredFieldBaseData have a full blown StructuredFieldIntroducer but beside that provides only getter and setter for the structured fields's payload.
    
    This mode is especially usefull when dealing with AFP data that isn't fully compliant to AFP standards. In this mode, the parser is less restrictive, e.g. doesn't care if the length of the structured field or individual attribute values are valid according to AFP specifications.
  - getCurrentCPD_CodePageDescriptor
```
public CPD_CodePageDescriptor getCurrentCPD_CodePageDescriptor()
```
  - getCurrentCodePageControl
```
public CPC_CodePageControl getCurrentCodePageControl()
```
  - isBuildShallow
```
public boolean isBuildShallow()
```
    Returns true if the parser is building shallow StructuredFields. Shallow SFs consist only of StructuredFieldIntroducer, the value of all other fields remain undefined until AFPParser.reload(StructuredField) is called. Shallow SFs require considerably less memory than fully realized SFs.
  - setBuildShallow
```
public void setBuildShallow(boolean isBuildShallow)
```
    If set to true the parser is building shallow StructuredFields. See isBuildShallow().
  - isEscalateParsingErrors
```
public boolean isEscalateParsingErrors()
```
  - setEscalateParsingErrors
```
public void setEscalateParsingErrors(boolean escalateParsingErrors)
```
    If set to true (default) and a parsing error occurs, an AFPParserException is thrown that carries the erroneous structured field as an StructuredFieldErrornouslyBuilt.
    If set to false and a parsing error occurs, AFPParser.parseNextSF() returns a StructuredField of type StructuredFieldErrornouslyBuilt without throwing an exception and continues parsing the rest of the AFP stream.
    
    Parameters:
    
    escalateParsingErrors - true if parsing errors should be escalated.
  - clone
```
public AFPParserConfiguration clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - getCurrentBarCodeDataDescriptor
```
public BDD_BarCodeDataDescriptor getCurrentBarCodeDataDescriptor()
```
  - setCurrentBarCodeDataDescriptor
```
public void setCurrentBarCodeDataDescriptor(BDD_BarCodeDataDescriptor currentBarCodeDataDescriptor)
```
  - getCurrentCodePageDescriptor
```
public CPD_CodePageDescriptor getCurrentCodePageDescriptor()
```
  - setCurrentCodePageDescriptor
```
public void setCurrentCodePageDescriptor(CPD_CodePageDescriptor currentCodePageDescriptor)
```
  - getCurrentPageControl
```
public CPC_CodePageControl getCurrentPageControl()
```
  - setCurrentPageControl
```
public void setCurrentPageControl(CPC_CodePageControl currentPageControl)
```
  - getAFPFile
```
public java.io.File getAFPFile()
```
  - setAFPFile
```
public void setAFPFile(java.io.File afpFile)
```
  - resetCurrentAFPObjects
```
public void resetCurrentAFPObjects()
```
    Resets all preserved AFP objects that are needed by the parser for later reference to null.

Class AFPParserConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

isParserOwnsInputStream

Constructor Detail

AFPParserConfiguration

Method Detail

getAfpCharSet

setAfpCharSet

getBufferSize

setBufferSize

getInputStream

setInputStream

getCurrentFontControl

setCurrentFontControl

isParseToStructuredFieldsBaseData

setParseToStructuredFieldsBaseData

getCurrentCPD_CodePageDescriptor

getCurrentCodePageControl

isBuildShallow

setBuildShallow

isEscalateParsingErrors

setEscalateParsingErrors

clone

getCurrentBarCodeDataDescriptor

setCurrentBarCodeDataDescriptor

getCurrentCodePageDescriptor

setCurrentCodePageDescriptor

getCurrentPageControl

setCurrentPageControl

getAFPFile

setAFPFile

resetCurrentAFPObjects