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.

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

build

public static Result build(@NotNull
                           @NotNull Error error)

Builds a new instance of an operation result

Parameters:

error - wrapped error code

Returns:

new result instance

build

public static Result build(@NotNull
                           @NotNull 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(@NotNull
                           @NotNull Error error,
                           @Nullable
                           @Nullable 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

getError

@NotNull
public @NotNull 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

@NotNull
public @NotNull String getMessage()

Gets the error message of the result

Returns:

error message

getException

@Nullable
public @Nullable Exception getException()

Returns the exception behind the result

Returns:

exception

addMessage

@NotNull
public @NotNull Result addMessage(@Nullable
                                            @Nullable String message)

Adds an additional error message text

Parameters:

message - additional message

Returns:

the result object