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, PasswordProtectedExceptionSupportTask

Direct Known Subclasses:

LocalConversionTask

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

Base class for all local office tasks implementation.

See Also:

OfficeTask

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.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 java.util.Map<java.lang.String,java.lang.Object> loadProperties) Creates a new task with the specified source document.

Method Summary

Modifier and Type	Method and Description
protected static void	appendProperties(@NonNull java.util.Map<java.lang.String,java.lang.Object> properties, @Nullable java.util.Map<java.lang.String,java.lang.Object> toAddProperties)
protected void	closeDocument(@Nullable com.sun.star.lang.XComponent document)
protected @NonNull java.util.Map<java.lang.String,java.lang.Object>	getLoadProperties()
boolean	hasPasswordInteractionRequest() Gets whether a password interaction request has been made.
protected @NonNull com.sun.star.lang.XComponent	loadDocument(@NonNull LocalOfficeContext context, @NonNull java.io.File sourceFile)
@NonNull java.lang.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 java.util.Map<java.lang.String,java.lang.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 java.util.Map<java.lang.String,java.lang.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 java.util.Map<java.lang.String,java.lang.Object> properties,
                                       @Nullable java.util.Map<java.lang.String,java.lang.Object> toAddProperties)

getLoadProperties

protected @NonNull java.util.Map<java.lang.String,java.lang.Object> getLoadProperties()

loadDocument

protected @NonNull com.sun.star.lang.XComponent loadDocument(@NonNull LocalOfficeContext context,
                                                             @NonNull java.io.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)

hasPasswordInteractionRequest

public boolean hasPasswordInteractionRequest()

Description copied from interface: PasswordProtectedExceptionSupportTask

Gets whether a password interaction request has been made.

Specified by:

hasPasswordInteractionRequest in interface PasswordProtectedExceptionSupportTask

Returns:

true if a password interaction request was made, false otherwise.

toString

public @NonNull java.lang.String toString()

Overrides:

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