Package io.inversion

Class Validation

java.lang.Object

io.inversion.Validation

public class Validation
extends java.lang.Object

Utility designed to make it easy to validate request properties or request body json values while you are retrieving them.

Required (Not Null)

To ensure a field is not null, use the required() method:

• String nameFirst = request.validate("nameFirst", "A first name is required").required().asString();

Comparison

To validate a number is greater than 5, then return its value:

• int myParam = request.validate("myParamName", "optional_custom_error_message").gt(5).asInt();

See Also:

Request.validate(String), Request.validate(String, String)

Constructor Summary

Constructors

Constructor	Description
Validation(Request req, java.lang.String propOrPath, java.lang.String customErrorMessage)
Validation(Response res, java.lang.String jsonPath, java.lang.String customErrorMessage)

Method Summary

Modifier and Type	Method	Description
io.inversion.json.JSList	asArray()
boolean	asBoolean()
double	asDouble()
int	asInt()
io.inversion.json.JSNode	asNode()
java.lang.String	asString()
protected int	compareTo(java.lang.Object compareTo)
Validation	eq(java.lang.Object compareTo)
protected void	fail(java.lang.String defaultErrorMessage)	Throws an ApiException 400 using customErrorMessage or defaultErrorMessage
Validation	ge(java.lang.Object compareTo)
Validation	gt(java.lang.Object compareTo)
Validation	in(java.lang.Object... possibleValues)
Validation	le(java.lang.Object compareTo)
Validation	length(int max)
Validation	length(int min, int max)
Validation	lt(java.lang.Object compareTo)
Validation	matches(java.lang.String regex)
Validation	matches(java.util.regex.Pattern regex)
Validation	max(java.lang.Number max)
Validation	min(java.lang.Number min)
Validation	minMax(java.lang.Number min, java.lang.Number max)
Validation	ne(java.lang.Object compareTo)
Validation	out(java.lang.Object... excludedValues)
Validation	required(java.lang.String... childProps)	If there are any childProps they must exist on the JSNode found at pathOrProp.
java.lang.Object	value()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Validation

public Validation(Request req,
                  java.lang.String propOrPath,
                  java.lang.String customErrorMessage)

Validation

public Validation(Response res,
                  java.lang.String jsonPath,
                  java.lang.String customErrorMessage)

Method Detail

required

public Validation required(java.lang.String... childProps)

If there are any childProps they must exist on the JSNode found at pathOrProp. If childProps are null/empty then pathOrProp must not be null.

Parameters:

childProps - the child properties to check for

Returns:

this

Throws:

ApiException - 400 if the referenced validation is null.

matches

public Validation matches(java.util.regex.Pattern regex)

matches

public Validation matches(java.lang.String regex)

in

public Validation in(java.lang.Object... possibleValues)

out

public Validation out(java.lang.Object... excludedValues)

compareTo

protected int compareTo(java.lang.Object compareTo)

gt

public Validation gt(java.lang.Object compareTo)

ge

public Validation ge(java.lang.Object compareTo)

lt

public Validation lt(java.lang.Object compareTo)

le

public Validation le(java.lang.Object compareTo)

eq

public Validation eq(java.lang.Object compareTo)

ne

public Validation ne(java.lang.Object compareTo)

length

public Validation length(int max)

length

public Validation length(int min,
                         int max)

minMax

public Validation minMax(java.lang.Number min,
                         java.lang.Number max)

max

public Validation max(java.lang.Number max)

min

public Validation min(java.lang.Number min)

value

public java.lang.Object value()

asNode

public io.inversion.json.JSNode asNode()

asArray

public io.inversion.json.JSList asArray()

asString

public java.lang.String asString()

asInt

public int asInt()

asDouble

public double asDouble()

asBoolean

public boolean asBoolean()

fail

protected void fail(java.lang.String defaultErrorMessage)
             throws ApiException

Throws an ApiException 400 using customErrorMessage or defaultErrorMessage

Parameters:

defaultErrorMessage - the default error message

Throws:

ApiException - always