Package nz.org.riskscape.engine.bind

Interface ParamProblems

All Superinterfaces:

ProblemFactory

public interface ParamProblems
extends ProblemFactory

Method Summary

Modifier and Type	Method	Description
Problem	applyingDefault(String paramName, Object defaultValue)	No '' value was provided, using default value of ''
default Problem	bindingError(Parameter parameter, Object value, List<Problem> children)	Helper method for calling the right binding error method, depending on whether the given value is a ConfigString or not.
Problem	bindingError(Parameter parameter, Problem... children)
Problem	bindingErrorWithLocation(Parameter parameter, URI location, Problem... children)	Alternative to just problemsFound that includes the location where the problematic value was defined
static ParamProblems	get()
Problem	ignored(String key)	A parameter was given, but it was ignored.
Problem	ignored(Collection<String> unusedParameters)	Parameters were given, but were ignored.
Problem	ignoredWithHints(Collection<String> keys, Collection<String> available)	A parameter was given, but it was ignored.
Problem	invalidFor(Object thing)	Use when the parameters for a given object are invalid, e.g.
Problem	mutuallyExclusive(String paramA, String paramB)	'' and '' cannot both be specified at the same time
Problem	noBindingAvailable(Class<?> from, Class<?> to)	There was no binder available to bind from -> to.
Problem	noBindingAvailableForValue(Object value, Class<?> from, Class<?> to)	Similar to noBindingAvailable(java.lang.Class, java.lang.Class) but to be used along with bindingError(nz.org.riskscape.engine.bind.Parameter, nz.org.riskscape.problem.Problem...).
default Problem	oneOfTheseRequired(String... paramNames)	Convenience wrapper for oneOfTheseRequired(List) (because Arrays don't render very nicely in error messages).
Problem	oneOfTheseRequired(List<String> paramNames)	Return this when there are a set of optional parameters, but at least one of them is required
Problem	wrongNumberGiven(String paramName, String expected, int given)

Method Details

get

static ParamProblems get()

bindingError

default Problem bindingError(Parameter parameter,
 Object value,
 List<Problem> children)

Helper method for calling the right binding error method, depending on whether the given value is a ConfigString or not.

applyingDefault

Problem applyingDefault(String paramName,
 Object defaultValue)

No '' value was provided, using default value of ''

bindingError

Problem bindingError(Parameter parameter,
 Problem... children)

bindingErrorWithLocation

Problem bindingErrorWithLocation(Parameter parameter,
 URI location,
 Problem... children)

Alternative to just problemsFound that includes the location where the problematic value was defined

mutuallyExclusive

Problem mutuallyExclusive(String paramA,
 String paramB)

'' and '' cannot both be specified at the same time

wrongNumberGiven

Problem wrongNumberGiven(String paramName,
 String expected,
 int given)

oneOfTheseRequired

Problem oneOfTheseRequired(List<String> paramNames)

Return this when there are a set of optional parameters, but at least one of them is required

oneOfTheseRequired

default Problem oneOfTheseRequired(String... paramNames)

Convenience wrapper for oneOfTheseRequired(List) (because Arrays don't render very nicely in error messages).

invalidFor

Problem invalidFor(Object thing)

Use when the parameters for a given object are invalid, e.g. produces a message like: here was a problem with the parameters for

ignored

Problem ignored(String key)

A parameter was given, but it was ignored.

ignored

Problem ignored(Collection<String> unusedParameters)

Parameters were given, but were ignored.

ignoredWithHints

Problem ignoredWithHints(Collection<String> keys,
 Collection<String> available)

A parameter was given, but it was ignored.

noBindingAvailable

Problem noBindingAvailable(Class<?> from,
 Class<?> to)

There was no binder available to bind from -> to. This is not usually an error a user can do anything about, but this problem is here to i18n the exception

noBindingAvailableForValue

Problem noBindingAvailableForValue(Object value,
 Class<?> from,
 Class<?> to)

Similar to noBindingAvailable(java.lang.Class, java.lang.Class) but to be used along with bindingError(nz.org.riskscape.engine.bind.Parameter, nz.org.riskscape.problem.Problem...).