io.jooby

Class Usage

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.jooby.Usage

All Implemented Interfaces:

Serializable

public class Usage
extends RuntimeException

Usage exceptions. They provide a descriptive message with a link for a detailed section.

Since:

2.1.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Usage(String message, String id) Creates a new Usage exception.

Method Summary

Modifier and Type	Method and Description
static Usage	mvcRouterNotFound(Class mvcRoute) Creates a mvc route missing exception.
static Usage	parameterNameNotPresent(Parameter parameter) Thrown when the reflective bean converter has no access to a parameter name.

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

Usage

public Usage(@Nonnull
             String message,
             @Nonnull
             String id)

Creates a new Usage exception.

Parameters:

message - Message.

id - Link to detailed section.

Method Detail

mvcRouterNotFound

@Nonnull
public static Usage mvcRouterNotFound(@Nonnull
                                               Class mvcRoute)

Creates a mvc route missing exception.

Parameters:

mvcRoute - Mvc route.

Returns:

Usage exception.

parameterNameNotPresent

@Nonnull
public static Usage parameterNameNotPresent(@Nonnull
                                                     Parameter parameter)

Thrown when the reflective bean converter has no access to a parameter name. Compilation must be done using parameters compiler option.

Parameters:

parameter - Parameter.

Returns:

Usage exception.