com.documents4j.api

Interface IConversionJobWithSourceSpecified

public interface IConversionJobWithSourceSpecified

A conversion with a specified source for the conversion.

Method Summary

Modifier and Type	Method and Description
IConversionJobWithTargetUnspecified	to(File target) Configures the current conversion to write the result to the specified file target.
IConversionJobWithTargetUnspecified	to(File target, IFileConsumer callback) Configures the current conversion to write the result to the specified file target.
IConversionJobWithTargetUnspecified	to(IInputStreamConsumer callback) Configures the current conversion to write the result to invoke the given callback when the conversion terminates.
IConversionJobWithTargetUnspecified	to(OutputStream target) Configures the current conversion to write the result to the specified OutputStream.
IConversionJobWithTargetUnspecified	to(OutputStream target, boolean closeStream) Configures the current conversion to write the result to the specified OutputStream.

Method Detail

to

IConversionJobWithTargetUnspecified to(File target)

Configures the current conversion to write the result to the specified file target.

Parameters:

target - The file to which the result of the conversion will be written. Existing files will be overwritten. If the file is locked by the JVM or any other application or is not writable, the conversion will abort with an error.

Returns:

The current conversion specification.

to

IConversionJobWithTargetUnspecified to(File target,
                                       IFileConsumer callback)

Configures the current conversion to write the result to the specified file target. Addtionally, a callback is registered.

Parameters:

target - The file to which the result of the conversion will be written. Existing files will be overwritten. If the file is locked by the JVM or any other application or is not writable, the conversion will abort with an error.

callback - A callback that is invoked when the conversion terminates.

Returns:

The current conversion specification.

to

IConversionJobWithTargetUnspecified to(OutputStream target)

Configures the current conversion to write the result to the specified OutputStream. The stream will be closed after the conversion is written.

Parameters:

target - The output stream to which the conversion result is written to.

Returns:

The current conversion specification.

to

IConversionJobWithTargetUnspecified to(OutputStream target,
                                       boolean closeStream)

Configures the current conversion to write the result to the specified OutputStream.

Parameters:

target - The output stream to which the conversion result is written to.

closeStream - Determines whether the output stream is closed after writting the result.

Returns:

The current conversion specification.

to

IConversionJobWithTargetUnspecified to(IInputStreamConsumer callback)

Configures the current conversion to write the result to invoke the given callback when the conversion terminates.

Parameters:

callback - A callback that is invoked when the conversion terminates.

Returns:

The current conversion specification.