org.jodconverter.local.task

Class AbstractLocalOfficeTask

java.lang.Object

org.jodconverter.core.task.AbstractOfficeTask

org.jodconverter.local.task.AbstractLocalOfficeTask

All Implemented Interfaces:

org.jodconverter.core.task.OfficeTask

Direct Known Subclasses:

LocalConversionTask

public abstract class AbstractLocalOfficeTask
extends org.jodconverter.core.task.AbstractOfficeTask

Base class for all local office tasks implementation.

See Also:

OfficeTask

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	loadProperties
protected boolean	useStreamAdapters

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

source

Constructor Summary

Constructors

Constructor and Description
AbstractLocalOfficeTask(@NonNull org.jodconverter.core.job.SourceDocumentSpecs source) Creates a new task with the specified source document.
AbstractLocalOfficeTask(@NonNull org.jodconverter.core.job.SourceDocumentSpecs source, boolean useStreamAdapters) Creates a new task with the specified source document.
AbstractLocalOfficeTask(@NonNull org.jodconverter.core.job.SourceDocumentSpecs source, boolean useStreamAdapters, @Nullable Map<String,Object> loadProperties) Creates a new task with the specified source document.

Method Summary

Modifier and Type	Method and Description
protected static void	appendProperties(@NonNull Map<String,Object> properties, @Nullable Map<String,Object> toAddProperties)
protected void	closeDocument(@Nullable com.sun.star.lang.XComponent document)
protected @NonNull Map<String,Object>	getLoadProperties()
protected @NonNull com.sun.star.lang.XComponent	loadDocument(@NonNull LocalOfficeContext context, @NonNull File sourceFile)
@NonNull String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jodconverter.core.task.OfficeTask

execute

Field Detail

loadProperties

protected final Map<String,Object> loadProperties

useStreamAdapters

protected final boolean useStreamAdapters

Constructor Detail

AbstractLocalOfficeTask

public AbstractLocalOfficeTask(@NonNull org.jodconverter.core.job.SourceDocumentSpecs source)

Creates a new task with the specified source document.

Parameters:

source - The source specifications of the document.

AbstractLocalOfficeTask

public AbstractLocalOfficeTask(@NonNull org.jodconverter.core.job.SourceDocumentSpecs source,
                               boolean useStreamAdapters)

Creates a new task with the specified source document.

Parameters:

source - The source specifications of the document.

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

AbstractLocalOfficeTask

public AbstractLocalOfficeTask(@NonNull org.jodconverter.core.job.SourceDocumentSpecs source,
                               boolean useStreamAdapters,
                               @Nullable Map<String,Object> loadProperties)

Creates a new task with the specified source document.

Parameters:

source - The source specifications of the document.

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 before the load properties of the document format specified in the source arguments.

Method Detail

appendProperties

protected static void appendProperties(@NonNull Map<String,Object> properties,
                                       @Nullable Map<String,Object> toAddProperties)

getLoadProperties

protected @NonNull Map<String,Object> getLoadProperties()

loadDocument

protected @NonNull com.sun.star.lang.XComponent loadDocument(@NonNull LocalOfficeContext context,
                                                             @NonNull File sourceFile)
                                                      throws org.jodconverter.core.office.OfficeException

Throws:

org.jodconverter.core.office.OfficeException

closeDocument

protected void closeDocument(@Nullable com.sun.star.lang.XComponent document)

toString

public @NonNull String toString()

Overrides:

toString in class org.jodconverter.core.task.AbstractOfficeTask