org.afplib.io.chains

Class NullChain

java.lang.Object

org.afplib.io.chains.NullChain

All Implemented Interfaces:

ChainLink

public class NullChain
extends Object
implements ChainLink

Constructor Summary

Constructors

Constructor and Description
NullChain()

Method Summary

Modifier and Type	Method and Description
boolean	needTwoPass() signals that this filter wants to read the AFP before actually modifying it.
boolean	onStructuredField(Chain chain, SF sf) is called for each structured field.

Methods inherited from class java.lang.Object

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

Constructor Detail

NullChain

public NullChain()

Method Detail

needTwoPass

public boolean needTwoPass()

Description copied from interface: ChainLink

signals that this filter wants to read the AFP before actually modifying it. Can be used to first know e.g. which IMMs are used in an AFP file. If needTwoPass returns true, onStructuredField will be first called with chain=null passing all SF for reading. The second pass actually requires a commit call on Chain.

Specified by:

needTwoPass in interface ChainLink

Returns:

true, if this filter wants to read the AFP before modifying it.

onStructuredField

public boolean onStructuredField(Chain chain,
                                 SF sf)
                          throws IOException

Description copied from interface: ChainLink

is called for each structured field. The implementing class needs to call commit on Chain for each structured field(s) it wants to be saved. If a filter does not commit the resulting AFP will be empty.

Specified by:

onStructuredField in interface ChainLink

Parameters:

chain - functional interface for committing changes or just passing SFs to the next filter

sf - structured field

Returns:

false, if the work of this filter is done.

Throws:

IOException