/*

* Jooby https://jooby.io

* Apache License Version 2.0 https://jooby.io/LICENSE.txt

* Copyright 2014 Edgar Espina

*/

package io.jooby;

import java.lang.reflect.Executable;

import java.lang.reflect.Parameter;

import java.util.stream.Stream;

import io.jooby.exception.ProvisioningException;

/**

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

*

* @since 2.1.0

*/

public class Usage extends RuntimeException {

/**

* Creates a new Usage exception.

*

* @param message Message.

* @param id Link to a detailed section.

*/

public Usage(String message, String id) {

this(

(message

+ "\nFor more details, please visit: "

+ System.getProperty("jooby.host", "https://jooby.io")

+ "/usage#"

+ id));

}

protected Usage(String message) {

super(message);

}

/**

* Occurs when trying to access a session which was not configured.

*

* @return No session present error mesage.

*/

public static Usage noSession() {

return new Usage("No session available. See https://jooby.io/#session-in-memory-session");

}

/**

* Thrown when the reflective bean converter has no access to a parameter name. Compilation must

* be done using <code>parameters</code> compiler option.

*

* @param parameter Parameter.

* @return Usage exception.

*/

public static Usage parameterNameNotPresent(Parameter parameter) {

Executable executable = parameter.getDeclaringExecutable();

int p = Stream.of(executable.getParameters()).toList().indexOf(parameter);

String message =

"Unable to provision parameter at position: '"

+ p

+ "', require by: "

+ ProvisioningException.toString(parameter.getDeclaringExecutable())

+ ". Parameter's name is missing";

return new Usage(message, "bean-converter-parameter-name-missing");

}

}