org.jodconverter.local.filter

Class DefaultFilterChain

java.lang.Object

org.jodconverter.local.filter.AbstractFilterChain

org.jodconverter.local.filter.DefaultFilterChain

All Implemented Interfaces:

FilterChain

public class DefaultFilterChain
extends AbstractFilterChain

Default implementation of FilterChain.

Field Summary

Fields inherited from class org.jodconverter.local.filter.AbstractFilterChain

filters, pos

Constructor Summary

Constructors

Constructor and Description
DefaultFilterChain() Creates a FilterChain without any filters that will always apply a RefreshFilter at the end of the chain.
DefaultFilterChain(boolean endsWithRefreshFilter) Creates a FilterChain without any filters.
DefaultFilterChain(boolean endsWithRefreshFilter, Filter... filters) Creates a FilterChain that will contain the specified filters.
DefaultFilterChain(Filter... filters) Creates a FilterChain that will contain the specified filters and will always apply a RefreshFilter at the end of the chain.

Method Summary

Modifier and Type	Method and Description
@NonNull FilterChain	copy() Creates and returns a copy of this object.
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.

Methods inherited from class org.jodconverter.local.filter.AbstractFilterChain

addFilter, doFilter, reset

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFilterChain

public DefaultFilterChain()

Creates a FilterChain without any filters that will always apply a RefreshFilter at the end of the chain. Filters can later on be added using AbstractFilterChain.addFilter(Filter).

DefaultFilterChain

public DefaultFilterChain(Filter... filters)

Creates a FilterChain that will contain the specified filters and will always apply a RefreshFilter at the end of the chain.

Parameters:

filters - The filters to add to the chain.

DefaultFilterChain

public DefaultFilterChain(boolean endsWithRefreshFilter)

Creates a FilterChain without any filters. Filters can later on be added using AbstractFilterChain.addFilter(Filter).

Parameters:

endsWithRefreshFilter - If true, a RefreshFilter will always be applied at the end of the chain.

DefaultFilterChain

public DefaultFilterChain(boolean endsWithRefreshFilter,
                          Filter... filters)

Creates a FilterChain that will contain the specified filters.

Parameters:

endsWithRefreshFilter - If true, a RefreshFilter will always be applied at the end of the chain.

filters - The filters to add to the chain.

Method Detail

copy

public @NonNull FilterChain copy()

Description copied from interface: FilterChain

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the chain.

Returns:

The copy of this 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

Overrides:

doFilter in class AbstractFilterChain

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.