パッケージ org.thinkit.framework.envali.result

クラス BusinessError

java.lang.Object

org.thinkit.framework.envali.result.BusinessError

すべての実装されたインタフェース:

Serializable

public final class BusinessError
extends Object
implements Serializable

The class that represents a business error.

BusinessError handles both recoverable error and unrecoverable error, and can be instantiated by calling the dedicated static constructor for each.

Provides hasNestedError() as a feature to test if a nested error of ValidationResult exists, and hasError() to test if a business error exists.

 No error:
 
 BusinessError businessError = BusinessError.none();
 
 

 Recoverable error:
 
 BusinessError businessError = BusinessError.recoverable("any error message");
 
 

 Unrecoverable error:
 
 BusinessError businessError = BusinessError.unrecoverable("any error message");
 
 

 Nested error:
 
 BusinessError businessError = BusinessError.nestedError(validationResult);
 businessError.hasNestedError(); // It returns true
 
 

導入されたバージョン:

1.0.1

関連項目:

直列化された形式

メソッドの概要

修飾子とタイプ	メソッド	説明
boolean	equals(Object o)
String	getMessage()	The message
ValidationResult	getNestedError()	The nested error
boolean	hasError()	Tests for the presence of business error.
int	hashCode()
boolean	hasNestedError()	Tests for the presence of nested error.
boolean	isRecoverable()	Tests if a business error is a recoverable error.
boolean	isUnrecoverable()	Tests if a business error is an unrecoverable error.
static BusinessError	nestedError(@NonNull ValidationResult nestedError)	Returns the new instance of BusinessError with the nested error of ValidationResult .
static BusinessError	none()	Returns the new instance of BusinessError with the error type InternalErrorType.NONE .
static BusinessError	recoverable(@NonNull String message)	Returns the new instance of BusinessError with the error type InternalErrorType.RECOVERABLE .
String	toString()
static BusinessError	unrecoverable(@NonNull String message)	Returns the new instance of BusinessError with the error type InternalErrorType.UNRECOVERABLE .

クラスから継承されたメソッド java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

メソッドの詳細

none

public static BusinessError none()

Returns the new instance of BusinessError with the error type InternalErrorType.NONE . The instance of BusinessError created by none() indicates that there is no error.

戻り値:

The new instance of BusinessError with the error type InternalErrorType.NONE

recoverable

public static BusinessError recoverable(@NonNull
@NonNull String message)

Returns the new instance of BusinessError with the error type InternalErrorType.RECOVERABLE . The instance of BusinessError created by recoverable(String) indicates a recoverable error.

Use unrecoverable(String) if you want to get an instance that indicates an unrecoverable error.

パラメータ:

message - The error message

戻り値:

The new instance of BusinessError with the error type InternalErrorType.RECOVERABLE

例外:

NullPointerException - If null is passed as an argument

unrecoverable

public static BusinessError unrecoverable(@NonNull
@NonNull String message)

Returns the new instance of BusinessError with the error type InternalErrorType.UNRECOVERABLE . The instance of BusinessError created by unrecoverable(String) indicates a unrecoverable error.

Use recoverable(String) if you want to get an instance that indicates an recoverable error.

パラメータ:

message - The error message

戻り値:

The new instance of BusinessError with the error type InternalErrorType.UNRECOVERABLE

例外:

NullPointerException - If null is passed as an argument

nestedError

public static BusinessError nestedError(@NonNull
@NonNull ValidationResult nestedError)

Returns the new instance of BusinessError with the nested error of ValidationResult .

パラメータ:

nestedError - The nested error of ValidationResult

戻り値:

The new instance of BusinessError with the nested error of ValidationResult

例外:

NullPointerException - If null is passed as an argument

hasError

public boolean hasError()

Tests for the presence of business error.

戻り値:

true if there is a business error, otherwise false

hasNestedError

public boolean hasNestedError()

Tests for the presence of nested error.

戻り値:

true if there is a nested error, otherwise false

isRecoverable

public boolean isRecoverable()

Tests if a business error is a recoverable error.

戻り値:

true if a business error is a recoverable error, otherwise false

isUnrecoverable

public boolean isUnrecoverable()

Tests if a business error is an unrecoverable error.

戻り値:

true if a business error is an unrecoverable error, otherwise false

toString

public String toString()

オーバーライド:

toString クラス内 Object

equals

public boolean equals(Object o)

オーバーライド:

equals クラス内 Object

hashCode

public int hashCode()

オーバーライド:

hashCode クラス内 Object

getMessage

public String getMessage()

The message

getNestedError

public ValidationResult getNestedError()

The nested error