org.jodconverter.local.filter

Class AbstractFilterChain

java.lang.Object

org.jodconverter.local.filter.AbstractFilterChain

All Implemented Interfaces:

FilterChain

Direct Known Subclasses:

DefaultFilterChain, UnmodifiableFilterChain

public abstract class AbstractFilterChain
extends Object
implements FilterChain

Base class of a FilterChain.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Filter>	filters
protected int	pos

Constructor Summary

Constructors

Constructor and Description
AbstractFilterChain() Creates a FilterChain.
AbstractFilterChain(boolean readOnly, Filter... filters) Creates a FilterChain that will contain the specified filters.
AbstractFilterChain(Filter... filters) Creates a FilterChain that will contain the specified filters.

Method Summary

Modifier and Type	Method and Description
void	addFilter(@NonNull Filter filter) Adds a filter to the chain.
protected void	doFilter(@NonNull Filter filter, @NonNull org.jodconverter.core.office.OfficeContext context, @NonNull com.sun.star.lang.XComponent document) Causes the specified filter to be invoked.
void	doFilter(@NonNull org.jodconverter.core.office.OfficeContext context, @NonNull com.sun.star.lang.XComponent document) Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain, do nothing.
void	reset() Resets the position in the filter chain to 0, making the chain reusable.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jodconverter.local.filter.FilterChain

copy

Field Detail

filters

protected List<Filter> filters

pos

protected int pos

Constructor Detail

AbstractFilterChain

public AbstractFilterChain()

Creates a FilterChain.

AbstractFilterChain

public AbstractFilterChain(Filter... filters)

Creates a FilterChain that will contain the specified filters.

Parameters:

filters - The filters to add to the chain.

AbstractFilterChain

public AbstractFilterChain(boolean readOnly,
                           Filter... filters)

Creates a FilterChain that will contain the specified filters.

Parameters:

readOnly - true If the chain must be read-only (which means that no other filter can be added to the chain), false otherwise.

filters - The filters to initially add to the chain.

Method Detail

addFilter

public void addFilter(@NonNull Filter filter)

Description copied from interface: FilterChain

Adds a filter to the chain.

Specified by:

addFilter in interface FilterChain

Parameters:

filter - The filter to add at the end of the chain.

doFilter

public void doFilter(@NonNull org.jodconverter.core.office.OfficeContext context,
                     @NonNull com.sun.star.lang.XComponent document)
              throws org.jodconverter.core.office.OfficeException

Description copied from interface: FilterChain

Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain, do nothing.

Specified by:

doFilter in interface FilterChain

Parameters:

context - The OfficeContext in use to pass along the chain.

document - The XComponent being converted to pass along the chain.

Throws:

org.jodconverter.core.office.OfficeException - If an error occurs processing the filter.

doFilter

protected void doFilter(@NonNull Filter filter,
                        @NonNull org.jodconverter.core.office.OfficeContext context,
                        @NonNull com.sun.star.lang.XComponent document)
                 throws org.jodconverter.core.office.OfficeException

Causes the specified filter to be invoked.

Parameters:

filter - The filter to execute.

context - The context in use to pass along the chain.

document - The document being converted to pass along the chain.

Throws:

org.jodconverter.core.office.OfficeException - If an error occurs processing the filter.

reset

public void reset()

Resets the position in the filter chain to 0, making the chain reusable.