me.alidg.errors

Class HandledException

java.lang.Object

me.alidg.errors.HandledException

public class HandledException
extends Object

Encapsulates details about a handled exception, including:

• The mapped business level error codes
• The corresponding HTTP status code
• A collection of arguments that can be used for message translation

Author:

Ali Dehghani

See Also:

WebErrorHandler

Constructor Summary

Constructors

Constructor and Description
HandledException(Set<String> errorCodes, org.springframework.http.HttpStatus statusCode, Map<String,List<?>> arguments) Initialize a handled exception with a set of error codes, a HTTP status code and an optional collection of arguments.
HandledException(String errorCode, org.springframework.http.HttpStatus statusCode, Map<String,List<?>> arguments) Initialize a handled exception with an error code, a HTTP status code and an optional collection of arguments.

Method Summary

Modifier and Type	Method and Description
Map<String,List<?>>	getArguments()
Set<String>	getErrorCodes()
org.springframework.http.HttpStatus	getStatusCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

HandledException

public HandledException(@NonNull
                        Set<String> errorCodes,
                        @NonNull
                        org.springframework.http.HttpStatus statusCode,
                        @Nullable
                        Map<String,List<?>> arguments)

Initialize a handled exception with a set of error codes, a HTTP status code and an optional collection of arguments.

Parameters:

errorCodes - The corresponding error codes for the handled exception.

statusCode - The corresponding status code for the handled exception.

arguments - Arguments to be exposed from the handled exception to the outside world.

Throws:

NullPointerException - When one of the required parameters is null.

IllegalArgumentException - At least one error code should be provided.

HandledException

public HandledException(@NonNull
                        String errorCode,
                        @NonNull
                        org.springframework.http.HttpStatus statusCode,
                        @Nullable
                        Map<String,List<?>> arguments)

Initialize a handled exception with an error code, a HTTP status code and an optional collection of arguments.

Parameters:

errorCode - The corresponding error code for the handled exception.

statusCode - The corresponding status code for the handled exception.

arguments - Arguments to be exposed from the handled exception to the outside world.

Throws:

NullPointerException - When one of the required parameters is null.

IllegalArgumentException - At least one error code should be provided.

Method Detail

getErrorCodes

@NonNull
public Set<String> getErrorCodes()

Returns:

Collection of mapped error codes.

See Also:

errorCodes

getStatusCode

@NonNull
public org.springframework.http.HttpStatus getStatusCode()

Returns:

The mapped status code.

See Also:

statusCode

getArguments

@NonNull
public Map<String,List<?>> getArguments()

Returns:

Collection of to-be-exposed arguments.

See Also:

arguments