Package org.forgerock.api.models

Class Errors

java.lang.Object

org.forgerock.api.models.Errors

public final class Errors
extends Object

Class that represents API descriptor ApiError errors.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Errors.Builder	Builder to help construct the Errors.

Field Summary

Fields

Modifier and Type	Field	Description
static final org.forgerock.api.models.Errors.ErrorEntryComparator	ERROR_ENTRY_COMPARATOR	ApiError Map-entry Comparator, which sorts by code and description.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static Errors.Builder	errors()	Create a new Builder for Errors.
ApiError	get(String name)	Gets the ApiError for a given ApiError-name.
Map<String,ApiError>	getErrors()	Gets a Map of error-names to ApiErrors.
Set<String>	getNames()	Returns all ApiError names.
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Details

ERROR_ENTRY_COMPARATOR

public static final org.forgerock.api.models.Errors.ErrorEntryComparator ERROR_ENTRY_COMPARATOR

ApiError Map-entry Comparator, which sorts by code and description.

Method Details

getErrors

public Map<String,ApiError> getErrors()

Gets a Map of error-names to ApiErrors.

Returns:

Map of error-names to ApiErrors.

get

public ApiError get(String name)

Gets the ApiError for a given ApiError-name.

Parameters:

name - ApiError name

Returns:

ApiError or null if does-not-exist.

getNames

public Set<String> getNames()

Returns all ApiError names.

Returns:

All ApiError names.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

errors

public static Errors.Builder errors()

Create a new Builder for Errors.

Returns:

Builder