org.jodconverter.local.task

Class LocalConversionTask

java.lang.Object

org.jodconverter.core.task.AbstractOfficeTask

org.jodconverter.local.task.AbstractLocalOfficeTask

org.jodconverter.local.task.LocalConversionTask

All Implemented Interfaces:

org.jodconverter.core.task.OfficeTask

public class LocalConversionTask
extends AbstractLocalOfficeTask

Represents the default behavior for a local conversion task.

Field Summary

Fields inherited from class org.jodconverter.local.task.AbstractLocalOfficeTask

loadProperties, useStreamAdapters

Fields inherited from class org.jodconverter.core.task.AbstractOfficeTask

source

Constructor Summary

Constructors

Constructor and Description
LocalConversionTask(@NonNull org.jodconverter.core.job.SourceDocumentSpecs source, @NonNull org.jodconverter.core.job.TargetDocumentSpecs target, boolean useStreamAdapters, @Nullable Map<String,Object> loadProperties, @Nullable Map<String,Object> storeProperties, @Nullable FilterChain filterChain) Creates a new conversion task from a specified source to a specified target.

Method Summary

Modifier and Type	Method and Description
void	execute(@NonNull org.jodconverter.core.office.OfficeContext context)
protected void	modifyDocument(@NonNull org.jodconverter.core.office.OfficeContext context, @NonNull com.sun.star.lang.XComponent document)
protected void	storeDocument(@NonNull com.sun.star.lang.XComponent document, @NonNull File targetFile)
@NonNull String	toString()

Methods inherited from class org.jodconverter.local.task.AbstractLocalOfficeTask

appendProperties, closeDocument, getLoadProperties, loadDocument

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalConversionTask

public LocalConversionTask(@NonNull org.jodconverter.core.job.SourceDocumentSpecs source,
                           @NonNull org.jodconverter.core.job.TargetDocumentSpecs target,
                           boolean useStreamAdapters,
                           @Nullable Map<String,Object> loadProperties,
                           @Nullable Map<String,Object> storeProperties,
                           @Nullable FilterChain filterChain)

Creates a new conversion task from a specified source to a specified target.

Parameters:

source - The source specifications for the conversion.

target - The target specifications for the conversion.

useStreamAdapters - Indicates whether document are loaded/stored using stream adapters.

loadProperties - The load properties to be applied when loading the document. These properties are added after the load properties of the document format specified in the source arguments.

storeProperties - The store properties to be applied when storing the document. These properties are added after the store properties of the document format specified in the target arguments.

filterChain - The filter chain to use with this task.

Method Detail

execute

public void execute(@NonNull org.jodconverter.core.office.OfficeContext context)
             throws org.jodconverter.core.office.OfficeException

Throws:

org.jodconverter.core.office.OfficeException

modifyDocument

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

Throws:

org.jodconverter.core.office.OfficeException

storeDocument

protected void storeDocument(@NonNull com.sun.star.lang.XComponent document,
                             @NonNull File targetFile)
                      throws org.jodconverter.core.office.OfficeException

Throws:

org.jodconverter.core.office.OfficeException

toString

public @NonNull String toString()

Overrides:

toString in class AbstractLocalOfficeTask