net.webpdf.wsclient.exception

Class Result

java.lang.Object

net.webpdf.wsclient.exception.Result

public final class Result
extends Object

An operation result with an error code (Error), an error message and an optional exception.

Field Summary

Fields

Modifier and Type	Field and Description
static Result	SUCCESS

Method Summary

Methods

Modifier and Type	Method and Description
Result	addMessage(String message) Adds an additional error message text
static Result	build(Error error) Builds a new instance of an operation result
static Result	build(Error error, Exception exception) Creates a new instance of an operation result
static Result	build(Error error, int exitCode) Builds a new instance of an operation result
boolean	equalsError(Error error) Compares the current error with a given error
int	getCode() Gets the error code of the result
Error	getError() Gets the error of the result
Exception	getException() Returns the exception behind the result
String	getMessage() Gets the error message of the result
boolean	isError() Is this result an error?
boolean	isSuccess() Is this an result for a successful operation?

Methods inherited from class java.lang.Object

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

Field Detail

SUCCESS

public static final Result SUCCESS

Method Detail

build

public static Result build(Error error)

Builds a new instance of an operation result

Parameters:

error - wrapped error code

Returns:

new result instance

build

public static Result build(Error error,
           int exitCode)

Builds a new instance of an operation result

Parameters:

error - wrapped error code

exitCode - wrapped exit code

Returns:

new result instance

build

public static Result build(Error error,
           Exception exception)

Creates a new instance of an operation result

Parameters:

error - wrapped error code

exception - wrapped exception

Returns:

new result instance

isError

public boolean isError()

Is this result an error?

Returns:

true = is an error result

isSuccess

public boolean isSuccess()

Is this an result for a successful operation?

Returns:

true = successful operation result

equalsError

public boolean equalsError(Error error)

Compares the current error with a given error

Parameters:

error - error code to compare with

Returns:

true = the error equals with the given error

getError

public Error getError()

Gets the error of the result

Returns:

error

getCode

public int getCode()

Gets the error code of the result

Returns:

error code

getMessage

public String getMessage()

Gets the error message of the result

Returns:

error message

getException

public Exception getException()

Returns the exception behind the result

Returns:

exception

addMessage

public Result addMessage(String message)

Adds an additional error message text

Parameters:

message - additional message

Returns:

the result object