org.jodconverter.local.filter

Class RefreshFilter

java.lang.Object

org.jodconverter.local.filter.RefreshFilter

All Implemented Interfaces:

Filter

public class RefreshFilter
extends Object
implements Filter

This filter is used to refresh a document.

Field Summary

Fields

Modifier and Type	Field and Description
static FilterChain	CHAIN Singleton instance of a FilterChain that will always contain a single RefreshFilter that won't call the next filter in the chain.
static RefreshFilter	LAST_REFRESH Singleton instance of refresh filter that won't call the next filter in the chain.
static RefreshFilter	REFRESH Singleton instance of refresh filter that will call the next filter in the chain.

Constructor Summary

Constructors

Constructor and Description
RefreshFilter() Creates a new refresh filter.
RefreshFilter(boolean lastFilter) Creates a new refresh filter that will call or not the next filter in the chain according to the specified argument.

Method Summary

Modifier and Type	Method and Description
void	doFilter(@NonNull org.jodconverter.core.office.OfficeContext context, @NonNull com.sun.star.lang.XComponent document, @NonNull FilterChain chain) The doFilter method of the Filter is called each time a document is passed through the chain due to a conversion request.

Methods inherited from class java.lang.Object

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

Field Detail

REFRESH

public static final RefreshFilter REFRESH

Singleton instance of refresh filter that will call the next filter in the chain.

Since:

4.3.1

LAST_REFRESH

public static final RefreshFilter LAST_REFRESH

Singleton instance of refresh filter that won't call the next filter in the chain. Use this filter only when you are absolutely sure that it will be used as last filter in a filter chain.

Since:

4.1.0

CHAIN

public static final FilterChain CHAIN

Singleton instance of a FilterChain that will always contain a single RefreshFilter that won't call the next filter in the chain. If a document is just converted from a format to another format, this chain should be used.

Since:

4.1.0

Constructor Detail

RefreshFilter

public RefreshFilter()

Creates a new refresh filter.

RefreshFilter

public RefreshFilter(boolean lastFilter)

Creates a new refresh filter that will call or not the next filter in the chain according to the specified argument.

Parameters:

lastFilter - If true, then the filter won't call the next filter in the chain. If false, the next filter in the chain, if any, will be applied.

Method Detail

doFilter

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

Description copied from interface: Filter

The doFilter method of the Filter is called each time a document is passed through the chain due to a conversion request. The FilterChain passed in to this method allows the Filter to pass on the document to the next entity in the chain.

A typical implementation of this method would either invoke the next filter in the chain using the FilterChain object (chain.doFilter()), or not pass on the document to the next filter in the filter chain to block the conversion processing.

Specified by:

doFilter in interface Filter

Parameters:

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

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

chain - The chain.

Throws:

Exception - If an error occurs processing the filter.