Package com.documents4j.job

Class AggregatingConverter

java.lang.Object

com.documents4j.job.AggregatingConverter

All Implemented Interfaces:

IAggregatingConverter, IConverter, IConverterFailureCallback, Runnable

public class AggregatingConverter
extends Object
implements IAggregatingConverter, IConverterFailureCallback, Runnable

A converter that aggregates several other converters and serves as a load balancer between these converters. At the same time, the converter automatically deregisters

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AggregatingConverter.Builder	A builder for creating an AggregatingConverter.

Field Summary

Fields inherited from interface com.documents4j.api.IConverter

JOB_PRIORITY_HIGH, JOB_PRIORITY_LOW, JOB_PRIORITY_NORMAL

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AggregatingConverter(CopyOnWriteArrayList<IConverter> converters, ISelectionStrategy selectionStrategy, IConverterFailureCallback converterFailureCallback, boolean propagateShutDown)

Method Summary

Modifier and Type	Method	Description
static AggregatingConverter.Builder	builder()	Creates a new builder instance.
IConversionJobWithSourceUnspecified	convert(IFileSource source)
IConversionJobWithSourceUnspecified	convert(IInputStreamSource source)
IConversionJobWithSourceUnspecified	convert(File source)
IConversionJobWithSourceUnspecified	convert(InputStream source)
IConversionJobWithSourceUnspecified	convert(InputStream source, boolean close)
Set<IConverter>	getConverters()	Returns a set of the converters that are currently registered by this aggregating converter.
Map<DocumentType,Set<DocumentType>>	getSupportedConversions()
boolean	isOperational()
void	kill()
static IAggregatingConverter	make(IConverter... converters)	Creates a new aggregation converter of the given converters.
static IAggregatingConverter	make(Collection<? extends IConverter> converters)	Creates a new aggregation converter of the given converters.
protected IConverter	nextConverter(DocumentType sourceFormat, DocumentType targetFormat)
void	onFailure(IConverter converter)	Invoked once for any converter that failed.
boolean	register(IConverter converter)	Registers an additional converter.
boolean	remove(IConverter converter)	Removes a converter.
void	run()
void	shutDown()

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregatingConverter

protected AggregatingConverter(CopyOnWriteArrayList<IConverter> converters,
                               ISelectionStrategy selectionStrategy,
                               IConverterFailureCallback converterFailureCallback,
                               boolean propagateShutDown)

Method Detail

builder

public static AggregatingConverter.Builder builder()

Creates a new builder instance.

Returns:

A new builder instance.

make

public static IAggregatingConverter make(IConverter... converters)

Creates a new aggregation converter of the given converters.

Parameters:

converters - The converters to aggregate.

Returns:

A new aggregation converter

make

public static IAggregatingConverter make(Collection<? extends IConverter> converters)

Creates a new aggregation converter of the given converters.

Parameters:

converters - The available converters.

Returns:

A new aggregation converter

getSupportedConversions

public Map<DocumentType,Set<DocumentType>> getSupportedConversions()

Specified by:

getSupportedConversions in interface IConverter

isOperational

public boolean isOperational()

Specified by:

isOperational in interface IConverter

nextConverter

protected IConverter nextConverter(DocumentType sourceFormat,
                                   DocumentType targetFormat)

convert

public IConversionJobWithSourceUnspecified convert(File source)

Specified by:

convert in interface IConverter

convert

public IConversionJobWithSourceUnspecified convert(InputStream source)

Specified by:

convert in interface IConverter

convert

public IConversionJobWithSourceUnspecified convert(InputStream source,
                                                   boolean close)

Specified by:

convert in interface IConverter

convert

public IConversionJobWithSourceUnspecified convert(IFileSource source)

Specified by:

convert in interface IConverter

convert

public IConversionJobWithSourceUnspecified convert(IInputStreamSource source)

Specified by:

convert in interface IConverter

register

public boolean register(IConverter converter)

Description copied from interface: IAggregatingConverter

Registers an additional converter.

Specified by:

register in interface IAggregatingConverter

Parameters:

converter - The converter to register.

Returns:

true if the converter was not already registered.

remove

public boolean remove(IConverter converter)

Description copied from interface: IAggregatingConverter

Removes a converter.

Specified by:

remove in interface IAggregatingConverter

Parameters:

converter - The converter to remove.

Returns:

true if the converter was previously registered and is now removed.

getConverters

public Set<IConverter> getConverters()

Description copied from interface: IAggregatingConverter

Returns a set of the converters that are currently registered by this aggregating converter.

Specified by:

getConverters in interface IAggregatingConverter

Returns:

The currently registered converters.

shutDown

public void shutDown()

Specified by:

shutDown in interface IConverter

kill

public void kill()

Specified by:

kill in interface IConverter

onFailure

public void onFailure(IConverter converter)

Description copied from interface: IConverterFailureCallback

Invoked once for any converter that failed. This method should not execute any heavy operations in the thread that invokes this method but rather return quickly.

Specified by:

onFailure in interface IConverterFailureCallback

Parameters:

converter - The converter that failed.

run

public void run()

Specified by:

run in interface Runnable