com.palantir.conjure.java.api.errors

Class ErrorType

java.lang.Object

com.palantir.conjure.java.api.errors.ErrorType

@Value.Immutable
public abstract class ErrorType
extends java.lang.Object

Represents errors by code and name. ErrorType instance are meant to be compile-time constants in the sense that the name should not contain information that is available at runtime only. By convention, and in alignment with the HTTP specification, errors associated with a 4xx HTTP status code are client errors, and errors associated with a 5xx status are server errors.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ErrorType.Code

Field Summary

Fields

Modifier and Type	Field and Description
static ErrorType	CONFLICT
static ErrorType	FAILED_PRECONDITION
static ErrorType	INTERNAL
static ErrorType	INVALID_ARGUMENT
static ErrorType	NOT_FOUND
static ErrorType	PERMISSION_DENIED
static ErrorType	REQUEST_ENTITY_TOO_LARGE
static ErrorType	TIMEOUT
static ErrorType	UNAUTHORIZED

Constructor Summary

Constructors

Constructor and Description
ErrorType()

Method Summary

Modifier and Type	Method and Description
abstract ErrorType.Code	code() The ErrorType.Code of this error.
static ErrorType	create(ErrorType.Code code, java.lang.String name) Constructs an ErrorType with the given error ErrorType.Code and name.
abstract int	httpErrorCode() The HTTP error code used to convey this error to HTTP clients.
abstract java.lang.String	name() The name of this error type.

Methods inherited from class java.lang.Object

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

Field Detail

UNAUTHORIZED

public static final ErrorType UNAUTHORIZED

PERMISSION_DENIED

public static final ErrorType PERMISSION_DENIED

INVALID_ARGUMENT

public static final ErrorType INVALID_ARGUMENT

REQUEST_ENTITY_TOO_LARGE

public static final ErrorType REQUEST_ENTITY_TOO_LARGE

NOT_FOUND

public static final ErrorType NOT_FOUND

CONFLICT

public static final ErrorType CONFLICT

FAILED_PRECONDITION

public static final ErrorType FAILED_PRECONDITION

INTERNAL

public static final ErrorType INTERNAL

TIMEOUT

public static final ErrorType TIMEOUT

Constructor Detail

ErrorType

public ErrorType()

Method Detail

code

public abstract ErrorType.Code code()

The ErrorType.Code of this error.

name

public abstract java.lang.String name()

The name of this error type. Names should be compile-time constants and are considered part of the API of a service that produces this error.

httpErrorCode

public abstract int httpErrorCode()

The HTTP error code used to convey this error to HTTP clients.

create

public static ErrorType create(ErrorType.Code code,
                               java.lang.String name)

Constructs an ErrorType with the given error ErrorType.Code and name.