me.alidg.errors.conf

Enum ErrorsProperties.ArgumentExposure

java.lang.Object

java.lang.Enum<ErrorsProperties.ArgumentExposure>

me.alidg.errors.conf.ErrorsProperties.ArgumentExposure

All Implemented Interfaces:

Serializable, Comparable<ErrorsProperties.ArgumentExposure>

Enclosing class:

ErrorsProperties

public static enum ErrorsProperties.ArgumentExposure
extends Enum<ErrorsProperties.ArgumentExposure>

Determines how we're gonna expose the arguments parameter for each error code.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS Always expose "arguments" element, even when there are no error arguments.
NEVER Never expose error arguments.
NON_EMPTY Expose error arguments only when there is anything to expose.

Method Summary

Modifier and Type	Method and Description
void	expose(Map<String,Object> error, List<Argument> arguments) Exposes the given arguments into the given error representation
static ErrorsProperties.ArgumentExposure	valueOf(String name) Returns the enum constant of this type with the specified name.
static ErrorsProperties.ArgumentExposure[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NEVER

public static final ErrorsProperties.ArgumentExposure NEVER

Never expose error arguments.

NON_EMPTY

public static final ErrorsProperties.ArgumentExposure NON_EMPTY

Expose error arguments only when there is anything to expose.

ALWAYS

public static final ErrorsProperties.ArgumentExposure ALWAYS

Always expose "arguments" element, even when there are no error arguments.

Method Detail

values

public static ErrorsProperties.ArgumentExposure[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ErrorsProperties.ArgumentExposure c : ErrorsProperties.ArgumentExposure.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ErrorsProperties.ArgumentExposure valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

expose

public void expose(Map<String,Object> error,
                   List<Argument> arguments)

Exposes the given arguments into the given error representation

Parameters:

error - The current error representation.

arguments - Collection of to be exposed arguments.