Package xj3d.filter

Class FilterExitCodes

java.lang.Object

xj3d.filter.FilterExitCodes

public class FilterExitCodes
extends Object

Collection of the exit codes for the server tools. Previously, these were located in CDFFilter, but by commonizing as many exit codes as we can we will make all our code bases more consistent. Other filter chains can extend this class to define project-specific exit codes if desired.

If everything is working as intended then exit code is equal to zero, or SUCCESS. If we encounter any abnormalities, errors, or exceptions, then a non-zero exit code should be used. In general, the lower the value of the non-zero exit code, the more we prioritize catching the error.

Version:

$Revision: 1.0 $

Author:

Eric Fickenscher

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ABNORMAL_CRASH	Unhandled exception.
static final int	CANNOT_WRITE_OUTPUT_FILE	Unable to write output file.
static final int	EXCEPTIONAL_ERROR	The software failed due to an exceptional error condition that is outside ordinary failure modes. Example: failure to find native libraries or other configuration error.
static final int	FILE_NOT_FOUND	Input file not found.
static final int	INVALID_ARGUMENTS	Invalid filter arguments provided other than file name. Example: arguments are out-of-bounds, or formatted incorrectly.
static final int	INVALID_FILTER_SPECIFIED	Invalid filter specified. For debugging purposes only on initial deployment.
static final int	INVALID_INPUT_FILE	Invalid input file format.
static final int	MAX_RUN_TIME_EXCEEDED	Exit code to use when application has timed out, exceeding the runtime specified by a -maxRunTime parameter
static final int	NOT_ALL_GEOMETRY_IS_CONVERTABLE	The file contained some content that cannot be converted to useable geometry.
static final int	OUT_OF_MEMORY	The software failed due to lack of memory.
static final int	RECOVERED_PARSING	Recovered a useable file from a incorrect file.
static final int	SUCCESS	Exit code used when no exceptions or errors have occurred
static final int	UNSUPPORTED_FORMAT	Exit code when a model is an supported file format.

Constructor Summary

Constructors

Constructor	Description
FilterExitCodes()

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

SUCCESS

public static final int SUCCESS

Exit code used when no exceptions or errors have occurred

See Also:

• Constant Field Values

FILE_NOT_FOUND

public static final int FILE_NOT_FOUND

Input file not found. Used when we can't read input file.

See Also:

• Constant Field Values

INVALID_INPUT_FILE

public static final int INVALID_INPUT_FILE

Invalid input file format.
Example: structural problem with the geometry format, meaning the X3D is incorrectly defined, such as geometry without a shape node.
Example: field is out of range.

See Also:

• Constant Field Values

CANNOT_WRITE_OUTPUT_FILE

public static final int CANNOT_WRITE_OUTPUT_FILE

Unable to write output file.
Example: Output file type unknown, or there is a write permission error or similar problem.

See Also:

• Constant Field Values

INVALID_ARGUMENTS

public static final int INVALID_ARGUMENTS

Invalid filter arguments provided other than file name.
Example: arguments are out-of-bounds, or formatted incorrectly.

See Also:

• Constant Field Values

INVALID_FILTER_SPECIFIED

public static final int INVALID_FILTER_SPECIFIED

Invalid filter specified.
For debugging purposes only on initial deployment.

See Also:

• Constant Field Values

NOT_ALL_GEOMETRY_IS_CONVERTABLE

public static final int NOT_ALL_GEOMETRY_IS_CONVERTABLE

The file contained some content that cannot be converted to useable geometry.
Example: X3D Switch nodes or LODs.

See Also:

• Constant Field Values

UNSUPPORTED_FORMAT

public static final int UNSUPPORTED_FORMAT

Exit code when a model is an supported file format. Usually happens with mislabled files or combo formats like VRML 1/2

See Also:

• Constant Field Values

RECOVERED_PARSING

public static final int RECOVERED_PARSING

Recovered a useable file from a incorrect file. Look at the model closely.

See Also:

• Constant Field Values

MAX_RUN_TIME_EXCEEDED

public static final int MAX_RUN_TIME_EXCEEDED

Exit code to use when application has timed out, exceeding the runtime specified by a -maxRunTime parameter

See Also:

• Constant Field Values

ABNORMAL_CRASH

public static final int ABNORMAL_CRASH

Unhandled exception. The software crashed abnormally. Probably error is due to a programming issue

See Also:

• Constant Field Values

OUT_OF_MEMORY

public static final int OUT_OF_MEMORY

The software failed due to lack of memory.

See Also:

• Constant Field Values

EXCEPTIONAL_ERROR

public static final int EXCEPTIONAL_ERROR

The software failed due to an exceptional error condition that is outside ordinary failure modes.
Example: failure to find native libraries or other configuration error.

See Also:

• Constant Field Values

Constructor Details

FilterExitCodes

public FilterExitCodes()