io.inversion

Class Request.Validation

java.lang.Object

io.inversion.Request.Validation

Enclosing class:

Request

public static class Request.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 and 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 and Description
JSArray	asArray()
boolean	asBoolean()
double	asDouble()
int	asInt()
JSNode	asNode()
java.lang.String	asString()
protected int	compareTo(java.lang.Object compareTo)
Request.Validation	eq(java.lang.Object compareTo)
protected void	fail(java.lang.String defaultErrorMessage) Throws an ApiException 400 using customErrorMessage or defaultErrorMessage
Request.Validation	ge(java.lang.Object compareTo)
Request.Validation	gt(java.lang.Object compareTo)
Request.Validation	in(java.lang.Object... possibleValues)
Request.Validation	le(java.lang.Object compareTo)
Request.Validation	length(int max)
Request.Validation	length(int min, int max)
Request.Validation	lt(java.lang.Object compareTo)
Request.Validation	matches(java.lang.String regex)
Request.Validation	max(java.lang.Number max)
Request.Validation	min(java.lang.Number min)
Request.Validation	minMax(java.lang.Number min, java.lang.Number max)
Request.Validation	ne(java.lang.Object compareTo)
Request.Validation	out(java.lang.Object... excludedValues)
Request.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 Request.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 Request.Validation matches(java.lang.String regex)

in

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

out

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

compareTo

protected int compareTo(java.lang.Object compareTo)

gt

public Request.Validation gt(java.lang.Object compareTo)

ge

public Request.Validation ge(java.lang.Object compareTo)

lt

public Request.Validation lt(java.lang.Object compareTo)

le

public Request.Validation le(java.lang.Object compareTo)

eq

public Request.Validation eq(java.lang.Object compareTo)

ne

public Request.Validation ne(java.lang.Object compareTo)

length

public Request.Validation length(int max)

length

public Request.Validation length(int min,
                                 int max)

minMax

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

max

public Request.Validation max(java.lang.Number max)

min

public Request.Validation min(java.lang.Number min)

value

public java.lang.Object value()

asNode

public JSNode asNode()

asArray

public JSArray 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