org.jooby

Class Err

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.jooby.Err

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Err.BadMediaType, Err.Missing

public class Err
extends RuntimeException

An exception that carry a Status. The status field will be set in the HTTP response. See Err.Handler for more details on how to deal with exceptions.

Since:

0.1.0

Author:

edgar

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Err.BadMediaType Exception thrown from MediaType.parse(String) in case of encountering an invalid media type specification String.
static class	Err.DefHandler Default err handler it does content negotation.
static interface	Err.Handler Handle and render exceptions.
static class	Err.Missing Missing parameter/header or request attribute.

Constructor Summary

Constructors

Constructor and Description
Err(int status) Creates a new Err.
Err(int status, String message) Creates a new Err.
Err(int status, String message, Throwable cause) Creates a new Err.
Err(int status, Throwable cause) Creates a new Err.
Err(Status status) Creates a new Err.
Err(Status status, String message) Creates a new Err.
Err(Status status, String message, Throwable cause) Creates a new Err.
Err(Status status, Throwable cause) Creates a new Err.
Err(WebSocket.CloseStatus status, String message) Creates a new Err.

Method Summary

Modifier and Type	Method and Description
int	statusCode()
Map<String,Object>	toMap() Produces a friendly view of the err, resulting map has these attributes:
Map<String,Object>	toMap(boolean stacktrace) Produces a friendly view of the err, resulting map has these attributes:

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Err

public Err(Status status,
           String message,
           Throwable cause)

Creates a new Err.

Parameters:

status - A HTTP status. Required.

message - A error message. Required.

cause - The cause of the problem.

Err

public Err(int status,
           String message,
           Throwable cause)

Creates a new Err.

Parameters:

status - A HTTP status. Required.

message - A error message. Required.

cause - The cause of the problem.

Err

public Err(WebSocket.CloseStatus status,
           String message)

Creates a new Err.

Parameters:

status - A web socket close status. Required.

message - Close message.

Err

public Err(Status status,
           String message)

Creates a new Err.

Parameters:

status - A HTTP status. Required.

message - A error message. Required.

Err

public Err(int status,
           String message)

Creates a new Err.

Parameters:

status - A HTTP status. Required.

message - A error message. Required.

Err

public Err(Status status,
           Throwable cause)

Creates a new Err.

Parameters:

status - A HTTP status. Required.

cause - The cause of the problem.

Err

public Err(int status,
           Throwable cause)

Creates a new Err.

Parameters:

status - A HTTP status. Required.

cause - The cause of the problem.

Err

public Err(Status status)

Creates a new Err.

Parameters:

status - A HTTP status. Required.

Err

public Err(int status)

Creates a new Err.

Parameters:

status - A HTTP status. Required.

Method Detail

statusCode

public int statusCode()

Returns:

The status code to send as response.

toMap

public Map<String,Object> toMap()

Produces a friendly view of the err, resulting map has these attributes:

  message: exception message (if present)
  status: status code
  reason: a status code reason
 

Returns:

A lightweight view of the err.

toMap

public Map<String,Object> toMap(boolean stacktrace)

Produces a friendly view of the err, resulting map has these attributes:

  message: exception message (if present)
  stacktrace: array with the stacktrace
  status: status code
  reason: a status code reason
 

Parameters:

stacktrace - True for adding stacktrace.

Returns:

A lightweight view of the err.