com.latitude.validator.spi

Class ExitStatus

java.lang.Object

com.latitude.validator.spi.ExitStatus

All Implemented Interfaces:

Comparable<ExitStatus>

public class ExitStatus
extends Object
implements Comparable<ExitStatus>

Value object used to carry information about the status of a ValidatorExecution. ExitStatus is immutable and therefore thread-safe.

Author:

Vincenzo Autiero

Field Summary

Fields

Modifier and Type	Field and Description
static ExitStatus	COMPLETED Convenient constant value representing completed state.
static ExitStatus	FAILED Convenient constant value representing failed state.
static ExitStatus	SKIPPED Convenient constant value representing skipped state.
static ExitStatus	UNKNOWN Convenient constant value representing unknown state.

Constructor Summary

Constructors

Constructor and Description
ExitStatus(String exitCode)
ExitStatus(String exitCode, String exitDescription)

Method Summary

Modifier and Type	Method and Description
ExitStatus	addExitDescription(String description) Add an exit description to an existing ExitStatus.
ExitStatus	and(ExitStatus status) Create a new ExitStatus with a logical combination of the exit code, and a concatenation of the descriptions.
int	compareTo(ExitStatus status)
boolean	equals(Object obj) Compare the fields one by one.
String	getExitCode() Getter for the exit code (defaults to blank).
String	getExitDescription() Getter for the exit description (defaults to blank)
int	hashCode() Compatible with the equals implementation.
ExitStatus	replaceExitCode(String code) Add an exit code to an existing ExitStatus.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

UNKNOWN

public static final ExitStatus UNKNOWN

Convenient constant value representing unknown state.

COMPLETED

public static final ExitStatus COMPLETED

Convenient constant value representing completed state.

FAILED

public static final ExitStatus FAILED

Convenient constant value representing failed state.

SKIPPED

public static final ExitStatus SKIPPED

Convenient constant value representing skipped state.

Constructor Detail

ExitStatus

public ExitStatus(String exitCode)

ExitStatus

public ExitStatus(String exitCode,
                  String exitDescription)

Method Detail

getExitCode

public String getExitCode()

Getter for the exit code (defaults to blank).

Returns:

the exit code.

getExitDescription

public String getExitDescription()

Getter for the exit description (defaults to blank)

Returns:

String containing the exit description.

and

public ExitStatus and(ExitStatus status)

Create a new ExitStatus with a logical combination of the exit code, and a concatenation of the descriptions. If either value has a higher severity then its exit code will be used in the result. In the case of equal severity, the exit code is replaced if the new value is alphabetically greater.

Severity is defined by the exit code:

• Codes beginning with COMPLETED have severity 1
• Codes beginning with SKIPPED have severity 2
• Codes beginning with FAILED have severity 3
• Codes beginning with UNKNOWN have severity 4

Others have severity 5, so custom exit codes always win.
If the input is null just return this.

Parameters:

status - an ExitStatus to combine with this one.

Returns:

a new ExitStatus combining the current value and the argument provided.

replaceExitCode

public ExitStatus replaceExitCode(String code)

Add an exit code to an existing ExitStatus. If there is already a code present tit will be replaced.

Parameters:

code - the code to add

Returns:

a new ExitStatus with the same properties but a new exit code.

addExitDescription

public ExitStatus addExitDescription(String description)

Add an exit description to an existing ExitStatus. If there is already a description present the two will be concatenated with a semicolon.

Parameters:

description - the description to add

Returns:

a new ExitStatus with the same properties but a new exit description

compareTo

public int compareTo(ExitStatus status)

Specified by:

compareTo in interface Comparable<ExitStatus>

Parameters:

status - an ExitStatus to compare

Returns:

greater than zero, 0, less than zero according to the severity and exit code

See Also:

Comparable

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Compare the fields one by one.

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Compatible with the equals implementation.

Overrides:

hashCode in class Object

See Also:

Object.hashCode()