com.documents4j.conversion

Enum ExternalConverterScriptResult

java.lang.Object

java.lang.Enum<ExternalConverterScriptResult>

com.documents4j.conversion.ExternalConverterScriptResult

All Implemented Interfaces:

Serializable, Comparable<ExternalConverterScriptResult>

public enum ExternalConverterScriptResult
extends Enum<ExternalConverterScriptResult>

Represents results of running a script as an external process. It encodes conventional error codes and maps them to appropriate actions to these results.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONVERSION_SUCCESSFUL Represents a successful conversion of a file.
CONVERTER_INACCESSIBLE Represents an interaction with a converter where the converter did not respond.
CONVERTER_INTERACTION_SUCCESSFUL Represents a successful interaction with an external converter.
ILLEGAL_CALL Represents an interaction with a converter which was not accepted by a converter for formal reasons.
ILLEGAL_INPUT Represents an interaction which was aborted because of the source file was found illegal.
INPUT_NOT_FOUND Represents an interaction which was aborted because of the source file was not found on the file system.
TARGET_INACCESSIBLE Represents an interaction which was aborted because of the target file was inaccessible.
UNKNOWN Represents an interaction with a converter which cannot be explained.

Method Summary

Modifier and Type	Method and Description
static ExternalConverterScriptResult	from(int exitValue)
Integer	getExitValue()
boolean	resolve()
String	toString()
static ExternalConverterScriptResult	valueOf(String name) Returns the enum constant of this type with the specified name.
static ExternalConverterScriptResult[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CONVERSION_SUCCESSFUL

public static final ExternalConverterScriptResult CONVERSION_SUCCESSFUL

Represents a successful conversion of a file.

CONVERTER_INTERACTION_SUCCESSFUL

public static final ExternalConverterScriptResult CONVERTER_INTERACTION_SUCCESSFUL

Represents a successful interaction with an external converter.

ILLEGAL_INPUT

public static final ExternalConverterScriptResult ILLEGAL_INPUT

Represents an interaction which was aborted because of the source file was found illegal.

TARGET_INACCESSIBLE

public static final ExternalConverterScriptResult TARGET_INACCESSIBLE

Represents an interaction which was aborted because of the target file was inaccessible.

INPUT_NOT_FOUND

public static final ExternalConverterScriptResult INPUT_NOT_FOUND

Represents an interaction which was aborted because of the source file was not found on the file system.

ILLEGAL_CALL

public static final ExternalConverterScriptResult ILLEGAL_CALL

Represents an interaction with a converter which was not accepted by a converter for formal reasons.

CONVERTER_INACCESSIBLE

public static final ExternalConverterScriptResult CONVERTER_INACCESSIBLE

Represents an interaction with a converter where the converter did not respond.

UNKNOWN

public static final ExternalConverterScriptResult UNKNOWN

Represents an interaction with a converter which cannot be explained.

Method Detail

values

public static ExternalConverterScriptResult[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ExternalConverterScriptResult c : ExternalConverterScriptResult.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ExternalConverterScriptResult valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

from

public static ExternalConverterScriptResult from(int exitValue)

resolve

public boolean resolve()

getExitValue

public Integer getExitValue()

toString

public String toString()

Overrides:

toString in class Enum<ExternalConverterScriptResult>