Package org.verapdf.cli

Enum CliConstants.ExitCodes

java.lang.Object

java.lang.Enum<CliConstants.ExitCodes>

org.verapdf.cli.CliConstants.ExitCodes

All Implemented Interfaces:

Serializable, Comparable<CliConstants.ExitCodes>

Enclosing class:

CliConstants

public static enum CliConstants.ExitCodes
extends Enum<CliConstants.ExitCodes>

All valid exit codes from veraPDF CLI

Version:

0.1

Author:

Carl Wilson carlwilson AT github

Enum Constant Summary

Enum Constants

Enum Constant	Description
BAD_PARAMS	Bad command line parameters
ENCRYPTED_FILES	Some PDF files encrypted.
FAILED_MULTIPROCESS_START	Failed to start multiprocess
FAILED_PARSING	Failed to parse one or more files
INTERRUPTED_EXCEPTION	Interrupted exception
INVALID	All files parsed, some invalid
IO_EXCEPTION	Java I/O Exception during processing
JAXB_EXCEPTION	JAXB exception thrown while processing
NO_FILES	No files from passed list or directory
OOM	Out of Memory
VALID	All files parsed and valid
VERAPDF_EXCEPTION	veraPDF exception thrown while processing

Field Summary

Fields

Modifier and Type	Field	Description
String	message	The appropriate help message for the exitCode
int	value	The numeric exit code for return to OS.

Method Summary

Modifier and Type	Method	Description
static CliConstants.ExitCodes	fromValue(int code)
static CliConstants.ExitCodes	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CliConstants.ExitCodes[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

VALID

public static final CliConstants.ExitCodes VALID

All files parsed and valid

INVALID

public static final CliConstants.ExitCodes INVALID

All files parsed, some invalid

BAD_PARAMS

public static final CliConstants.ExitCodes BAD_PARAMS

Bad command line parameters

OOM

public static final CliConstants.ExitCodes OOM

Out of Memory

NO_FILES

public static final CliConstants.ExitCodes NO_FILES

No files from passed list or directory

IO_EXCEPTION

public static final CliConstants.ExitCodes IO_EXCEPTION

Java I/O Exception during processing

FAILED_PARSING

public static final CliConstants.ExitCodes FAILED_PARSING

Failed to parse one or more files

ENCRYPTED_FILES

public static final CliConstants.ExitCodes ENCRYPTED_FILES

Some PDF files encrypted.

VERAPDF_EXCEPTION

public static final CliConstants.ExitCodes VERAPDF_EXCEPTION

veraPDF exception thrown while processing

JAXB_EXCEPTION

public static final CliConstants.ExitCodes JAXB_EXCEPTION

JAXB exception thrown while processing

FAILED_MULTIPROCESS_START

public static final CliConstants.ExitCodes FAILED_MULTIPROCESS_START

Failed to start multiprocess

INTERRUPTED_EXCEPTION

public static final CliConstants.ExitCodes INTERRUPTED_EXCEPTION

Interrupted exception

Field Detail

value

public final int value

The numeric exit code for return to OS.

message

public final String message

The appropriate help message for the exitCode

Method Detail

values

public static CliConstants.ExitCodes[] 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 (CliConstants.ExitCodes c : CliConstants.ExitCodes.values())
    System.out.println(c);

Returns:

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

valueOf

public static CliConstants.ExitCodes 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

fromValue

public static CliConstants.ExitCodes fromValue(int code)