Class InputValidationIssues
java.lang.Object
io.github.belgif.rest.problem.api.InputValidationIssues
Helper class for creating InputValidationIssues for common request validations.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final URI
static final URI
static final URI
static final URI
static final URI
static final URI
static final URI
static final URI
static final URI
static final URI
static final URI
static final URI
static final URI
static final URI
static final URI
static final URI
-
Method Summary
Modifier and TypeMethodDescriptionstatic InputValidationIssue
anyOfExpected
(List<Input<?>> inputs) static InputValidationIssue
canceledSsin
(InEnum in, String name, String ssin) static InputValidationIssue
equalExpected
(List<Input<?>> inputs) static InputValidationIssue
exactlyOneOfExpected
(List<Input<?>> inputs) static InputValidationIssue
invalidEnterpriseNumber
(InEnum in, String name, String enterpriseNumber) static InputValidationIssue
invalidEstablishmentUnitNumber
(InEnum in, String name, String establishmentUnitNumber) static InputValidationIssue
invalidIncompleteDate
(InEnum in, String name, String incompleteDate) static InputValidationIssue
invalidInput
(InEnum in, String name, Object value, String detail) static InputValidationIssue
invalidPeriod
(InEnum in, String name, Object period) static <T extends Temporal & Comparable<? super T>>
InputValidationIssueinvalidPeriod
(Input<T> start, Input<T> end) static InputValidationIssue
invalidSsin
(InEnum in, String name, String ssin) static InputValidationIssue
invalidStructure
(InEnum in, String name, Object value, String detail) static InputValidationIssue
invalidYearMonth
(InEnum in, String name, String yearMonth) static <T extends Comparable<T>>
InputValidationIssueoutOfRange
(InEnum in, String name, T value, T min, T max) static InputValidationIssue
referencedResourceNotFound
(InEnum in, String name, Object value) static InputValidationIssue
referencedResourceNotFound
(InEnum in, String parameterName, String resourceName, Object value) static <T> InputValidationIssue
referencedResourceNotFound
(InEnum in, String name, T value, List<T> source) Creates a properInputValidationIssue
for anISSUE_TYPE_REFERENCED_RESOURCE_NOT_FOUND
where the resource reference originated from a collection parameter.static InputValidationIssue
rejectedInput
(InEnum in, String name, Object value) static InputValidationIssue
replacedSsin
(InEnum in, String name, String ssin, String newSsin) static InputValidationIssue
static InputValidationIssue
requiredInput
(InEnum in, String name) static InputValidationIssue
requiredInputsIfPresent
(Input<?> target, List<Input<?>> inputs) static InputValidationIssue
schemaViolation
(InEnum in, String name, Object value, String detail) static InputValidationIssue
unknownInput
(InEnum in, String name, Object value) static InputValidationIssue
unknownSsin
(InEnum in, String name, String ssin) static InputValidationIssue
zeroOrAllOfExpected
(List<Input<?>> inputs) static InputValidationIssue
zeroOrExactlyOneOfExpected
(List<Input<?>> inputs)
-
Field Details
-
ISSUE_TYPE_SCHEMA_VIOLATION
-
ISSUE_TYPE_UNKNOWN_INPUT
-
ISSUE_TYPE_INVALID_INPUT
-
ISSUE_TYPE_REFERENCED_RESOURCE_NOT_FOUND
-
ISSUE_TYPE_INVALID_STRUCTURE
-
ISSUE_TYPE_OUT_OF_RANGE
-
ISSUE_TYPE_REJECTED_INPUT
-
ISSUE_TYPE_REQUIRED_INPUT
-
ISSUE_TYPE_INVALID_PERIOD
-
ISSUE_TYPE_REPLACED_SSIN
-
ISSUE_TYPE_CANCELED_SSIN
-
ISSUE_TYPE_EXACTLY_ONE_OF_EXPECTED
-
ISSUE_TYPE_ANY_OF_EXPECTED
-
ISSUE_TYPE_ZERO_OR_EXACTLY_ONE_OF_EXPECTED
-
ISSUE_TYPE_ZERO_OR_ALL_OF_EXPECTED
-
ISSUE_TYPE_EQUAL_EXPECTED
-
-
Method Details
-
schemaViolation
public static InputValidationIssue schemaViolation(InEnum in, String name, Object value, String detail) -
unknownInput
-
invalidInput
public static InputValidationIssue invalidInput(InEnum in, String name, Object value, String detail) -
invalidStructure
public static InputValidationIssue invalidStructure(InEnum in, String name, Object value, String detail) -
outOfRange
public static <T extends Comparable<T>> InputValidationIssue outOfRange(InEnum in, String name, T value, T min, T max) -
referencedResourceNotFound
-
referencedResourceNotFound
public static InputValidationIssue referencedResourceNotFound(InEnum in, String parameterName, String resourceName, Object value) -
referencedResourceNotFound
public static <T> InputValidationIssue referencedResourceNotFound(InEnum in, String name, T value, List<T> source) Creates a properInputValidationIssue
for anISSUE_TYPE_REFERENCED_RESOURCE_NOT_FOUND
where the resource reference originated from a collection parameter. For the sake of clarity the name (e.g. scopes) is enriched with its position in the collection.- Type Parameters:
T
- The type of the reference- Parameters:
in
- The location in the request of the parameter that contained the referencename
- The name of the parameter that contained the reference, will be enriched with its position in the sourceList
value
- The reference valuesource
- The sourceList
that contained the reference- Returns:
- A properly initialized
InputValidationIssue
for anISSUE_TYPE_REFERENCED_RESOURCE_NOT_FOUND
-
rejectedInput
-
requiredInput
-
requiredInputsIfPresent
-
replacedSsin
public static InputValidationIssue replacedSsin(InEnum in, String name, String ssin, String newSsin) -
replacedSsin
-
canceledSsin
-
invalidSsin
-
unknownSsin
-
invalidPeriod
-
invalidPeriod
public static <T extends Temporal & Comparable<? super T>> InputValidationIssue invalidPeriod(Input<T> start, Input<T> end) -
invalidIncompleteDate
public static InputValidationIssue invalidIncompleteDate(InEnum in, String name, String incompleteDate) -
invalidYearMonth
-
invalidEnterpriseNumber
public static InputValidationIssue invalidEnterpriseNumber(InEnum in, String name, String enterpriseNumber) -
invalidEstablishmentUnitNumber
public static InputValidationIssue invalidEstablishmentUnitNumber(InEnum in, String name, String establishmentUnitNumber) -
exactlyOneOfExpected
-
anyOfExpected
-
zeroOrExactlyOneOfExpected
-
zeroOrAllOfExpected
-
equalExpected
-