jp.ne.dti.lares.foozy.pagemixer.mixer
Class TrimFilter

java.lang.Object
  |
  +--jp.ne.dti.lares.foozy.pagemixer.mixer.Filter
        |
        +--jp.ne.dti.lares.foozy.pagemixer.mixer.TrimFilter

All Implemented Interfaces:

Consumer

Direct Known Subclasses:

ErrorsInsetFilter.Trim, ErrorsTrimFilter.Trim, ExceptionInsetFilter.Trim

public class TrimFilter

extends Filter

Template to trim whole token stream.

Inner classes inherited from class jp.ne.dti.lares.foozy.pagemixer.mixer.Filter

Filter.Factory

Constructor Summary

TrimFilter()
Create filter to trim whole sequence.

Method Summary

void	consume(ConsumerContext context, Token token) Consume token with specified context.
void	flush(ConsumerContext context) Finalize with specified context.
protected boolean	shouldTrim(ConsumerContext context) Decide whether token stream should be trimmed or not.

Methods inherited from class jp.ne.dti.lares.foozy.pagemixer.mixer.Filter

addCleanup, clear, connectTo, getConsumer

Methods inherited from class java.lang.Object

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

Constructor Detail

TrimFilter

public TrimFilter()

Create filter to trim whole sequence.

Method Detail

shouldTrim

protected boolean shouldTrim(ConsumerContext context)

Decide whether token stream should be trimmed or not.

You must override this method, if you want control trimming decision at execution time.

Parameters:

context - context processing depends on

Returns:

whether token stream should be trimmed or not.

consume

public void consume(ConsumerContext context,
                    Token token)

Description copied from class: Filter

Consume token with specified context.

Overrides:

consume in class Filter

Following copied from class: jp.ne.dti.lares.foozy.pagemixer.mixer.Filter

Parameters:

context - on which consuming processing depends

token - to be processed

Throws:

MixingIOException - IOException is thrown

flush

public void flush(ConsumerContext context)

Description copied from class: Filter

Finalize with specified context.

This method indicate end of token stream, in other word, works like "consume(context, EOF)".

Implementation class should clear internal status on completion of invocation.

Overrides:

flush in class Filter

Following copied from class: jp.ne.dti.lares.foozy.pagemixer.mixer.Filter

Parameters:

context - on which consuming processing depends on

Throws:

MixingIOException - IOException is thrown