Package io.github.belgif.rest.problem.api

Class InputValidationIssue

java.lang.Object

io.github.belgif.rest.problem.api.InputValidationIssue

public class InputValidationIssue
extends Object

Maps to InputValidationIssue in belgif/problem/v1/problem-v1.yaml.

Note that this model class intentionally does not include the "status" and "instance" properties. In problem-v1.yaml, InputValidationIssue technically inherits these properties from Problem, but they are not meant to be used for input validation issues. In the unlikely scenario where these properties would be needed, they can still be added/retrieved via the additionalProperties.

See Also:

• InputValidationProblem

Field Summary

Fields

Modifier and Type	Field	Description
static final Comparator<InputValidationIssue>	BY_NAME

Constructor Summary

Constructors

Constructor	Description
InputValidationIssue()
InputValidationIssue(InEnum in, String name)
InputValidationIssue(InEnum in, String name, Object value)
InputValidationIssue(URI type, String title)

Method Summary

Modifier and Type	Method	Description
void	addInput(Input<?> input)
InputValidationIssue	additionalProperty(String key, Object value)
InputValidationIssue	detail(String detail)
boolean	equals(Object o)
Map<String,Object>	getAdditionalProperties()
String	getDetail()
URI	getHref()
InEnum	getIn()
List<Input<?>>	getInputs()
String	getName()
String	getTitle()
URI	getType()
Object	getValue()
int	hashCode()
InputValidationIssue	href(String href)
InputValidationIssue	href(URI href)
InputValidationIssue	in(InEnum in)
InputValidationIssue	in(InEnum in, String name, Object value)
InputValidationIssue	in(Input<?> input)
InputValidationIssue	inputs(Input<?> firstInput, Input<?> secondInput, Input<?>... otherInputs)	Set the inputs[] to the given inputs.
InputValidationIssue	inputs(Collection<Input<?>> inputs)	Set the inputs[] to the given collection.
InputValidationIssue	localizedDetail(Class<?> context, String key, Object... args)	Set a localized detail message.
InputValidationIssue	localizedDetail(String key, Object... args)	Set a localized detail message.
InputValidationIssue	name(String name)
void	setAdditionalProperty(String name, Object value)
void	setDetail(String detail)
void	setHref(URI href)
void	setIn(InEnum in)
void	setName(String name)
void	setTitle(String title)
void	setType(URI type)
void	setValue(Object value)
InputValidationIssue	title(String title)
String	toString()
InputValidationIssue	type(String type)
InputValidationIssue	type(URI type)
InputValidationIssue	value(Object value)
InputValidationIssue	valueEntry(String key, Object value)	Deprecated. use inputs(Collection) or inputs(Input, Input, Input[]) to reference multiple input values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

BY_NAME

public static final Comparator<InputValidationIssue> BY_NAME

Constructor Details

InputValidationIssue

public InputValidationIssue()

InputValidationIssue

public InputValidationIssue(URI type,
 String title)

InputValidationIssue

public InputValidationIssue(InEnum in,
 String name,
 Object value)

InputValidationIssue

public InputValidationIssue(InEnum in,
 String name)

Method Details

getType

public URI getType()

setType

public void setType(URI type)

getHref

public URI getHref()

setHref

public void setHref(URI href)

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

getDetail

public String getDetail()

setDetail

public void setDetail(String detail)

getIn

public InEnum getIn()

setIn

public void setIn(InEnum in)

getName

public String getName()

setName

public void setName(String name)

getValue

public Object getValue()

setValue

public void setValue(Object value)

getInputs

public List<Input<?>> getInputs()

addInput

public void addInput(Input<?> input)

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
 Object value)

type

public InputValidationIssue type(URI type)

type

public InputValidationIssue type(String type)

href

public InputValidationIssue href(URI href)

href

public InputValidationIssue href(String href)

title

public InputValidationIssue title(String title)

detail

public InputValidationIssue detail(String detail)

localizedDetail

public InputValidationIssue localizedDetail(String key,
 Object... args)

Set a localized detail message.

Parameters:

key - the resource bundle key (without ".detail" suffix)

args - the optional arguments

Returns:

this InputValidationIssue

See Also:

• I18N.getLocalizedString(String, Object...)

localizedDetail

public InputValidationIssue localizedDetail(Class<?> context,
 String key,
 Object... args)

Set a localized detail message.

Parameters:

context - the context class where the resource bundle is loaded from

key - the resource bundle key (without ".detail" suffix)

args - the optional arguments

Returns:

this InputValidationIssue

See Also:

• I18N.getLocalizedString(Class, String, Object...)

in

public InputValidationIssue in(InEnum in,
 String name,
 Object value)

in

public InputValidationIssue in(Input<?> input)

in

public InputValidationIssue in(InEnum in)

name

public InputValidationIssue name(String name)

value

public InputValidationIssue value(Object value)

valueEntry

@Deprecated
public InputValidationIssue valueEntry(String key,
 Object value)

Deprecated.

use inputs(Collection) or inputs(Input, Input, Input[]) to reference multiple input values

Embed a key-value pair inside the value property.

Parameters:

key - the key

value - the value

Returns:

this InputValidationIssue

inputs

public InputValidationIssue inputs(Collection<Input<?>> inputs)

Set the inputs[] to the given collection.

Parameters:

inputs - collection with input items to initialize the inputs[] array. Any previous inputs are removed.

Returns:

this InputValidationIssue

Throws:

IllegalArgumentException - if in/name/value properties are not null (mutually exclusive with inputs[]), or when the collection only contains one non-null item.

inputs

public InputValidationIssue inputs(Input<?> firstInput,
 Input<?> secondInput,
 Input<?>... otherInputs)

Set the inputs[] to the given inputs.

Parameters:

firstInput - the first input

secondInput - the second input

otherInputs - the varargs array with other inputs

Returns:

this InputValidationIssue

Throws:

IllegalArgumentException - if in/name/value properties are not null (mutually exclusive with inputs[]), or when the parameters only contain one non-null item.

additionalProperty

public InputValidationIssue additionalProperty(String key,
 Object value)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object