spark

Class CustomErrorPages

java.lang.Object

spark.CustomErrorPages

public class CustomErrorPages
extends Object

Holds the custom error pages. A page can be defined as a String or a Route. Note that this class is always used statically therefore custom error pages will be shared between different instances of the Service class.

Field Summary

Fields

Modifier and Type	Field and Description
static String	INTERNAL_ERROR
static String	NOT_FOUND

Method Summary

Modifier and Type	Method and Description
static boolean	existsFor(int status) Verifies that a custom error page exists for the given status code
String	getDefaultFor(int status) Returns the default error page for a given status code.
static Object	getFor(int status, Request request, Response response) Gets the custom error page for a given status code.

Methods inherited from class java.lang.Object

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

Field Detail

NOT_FOUND

public static final String NOT_FOUND

See Also:

Constant Field Values

INTERNAL_ERROR

public static final String INTERNAL_ERROR

See Also:

Constant Field Values

Method Detail

existsFor

public static boolean existsFor(int status)

Verifies that a custom error page exists for the given status code

Parameters:

status -

Returns:

true if error page exists

getFor

public static Object getFor(int status,
                            Request request,
                            Response response)

Gets the custom error page for a given status code. If the custom error page is a route, the output of its handle method is returned. If the custom error page is a String, it is returned as an Object.

Parameters:

status -

request -

response -

Returns:

Object representing the custom error page

getDefaultFor

public String getDefaultFor(int status)

Returns the default error page for a given status code. Guaranteed to never be null.

Parameters:

status -

Returns:

String representation of the default error page.