Errors (OpenAM Server Only 7.4.1 Documentation)

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 class Errors.Builder
Builder to help construct the Errors.

Field Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 `ApiError`s.
`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 Detail
  - 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 Detail
  - 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