org.jodconverter.core.office

Class OfficeUtils

java.lang.Object

org.jodconverter.core.office.OfficeUtils

public final class OfficeUtils
extends Object

Provides helper functions for office.

Method Summary

Modifier and Type	Method and Description
static void	deleteOrRenameFile(@NonNull File file, long interval, long timeout) Deletes a file with a fallback (renaming) on deletion failure.
static @NonNull File	getDefaultWorkingDir() Gets the default working directory, which is the java.io.tmpdir system property.
static void	stopQuietly(@Nullable OfficeManager manager) Stops an OfficeManager unconditionally.
static void	validateWorkingDir(@NonNull File workingDir) Validates that the specified File instance is a valid working directory.

Methods inherited from class java.lang.Object

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

Method Detail

getDefaultWorkingDir

public static @NonNull File getDefaultWorkingDir()

Gets the default working directory, which is the java.io.tmpdir system property.

Returns:

A File instance that is default working directory.

validateWorkingDir

public static void validateWorkingDir(@NonNull File workingDir)

Validates that the specified File instance is a valid working directory. To be valid, a working directory must be a writable, existing directory.

Parameters:

workingDir - The directory to validate.

Throws:

IllegalStateException - If the specified directory if not a valid working directory.

stopQuietly

public static void stopQuietly(@Nullable OfficeManager manager)

Stops an OfficeManager unconditionally.

Equivalent to OfficeManager.stop(), except any exceptions will be ignored. This is typically used in finally blocks.

Example code:

 OfficeManager manager = null;
 try {
     manager = LocalOfficeManager().make();
     manager.start();

     // process manager

 } catch (Exception e) {
     // error handling
 } finally {
     OfficeUtils.stopQuietly(manager);
 }
 

Parameters:

manager - the manager to stop, may be null or already stopped.

deleteOrRenameFile

public static void deleteOrRenameFile(@NonNull File file,
                                      long interval,
                                      long timeout)

Deletes a file with a fallback (renaming) on deletion failure. If file is a directory, delete it and all subdirectories, with a .

Parameters:

file - File or directory to delete, can be null.

interval - The interval between each deletion attempt.

timeout - The timeout after which we won't try again to execute the deletion.