org.jodconverter.local.filter

Interface FilterChain

All Known Implementing Classes:

AbstractFilterChain, DefaultFilterChain, UnmodifiableFilterChain

public interface FilterChain

A FilterChain is an object that is responsible to manage an invocation chain of filters. Filters use the FilterChain to invoke the next filter in the chain, or if the calling filter is the last filter in the chain, to end the invocation chain.

Method Summary

Modifier and Type	Method and Description
void	addFilter(@NonNull Filter filter) Adds a filter to the chain.
@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.

Method Detail

addFilter

void addFilter(@NonNull Filter filter)

Adds a filter to the chain.

Parameters:

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

doFilter

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

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

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.

copy

@NonNull FilterChain copy()

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.