Package jsonvalues.spec

Class JsTupleSpec

java.lang.Object

jsonvalues.spec.JsTupleSpec

All Implemented Interfaces:

JsArraySpec, JsSpec

public final class JsTupleSpec
extends java.lang.Object
implements JsArraySpec

Represents a specification of every element of a Json array. It allows to define tuples and the schema of every of its elements.

Method Summary

Modifier and Type	Method	Description
boolean	isRequired()	Returns whether the key is optional.
JsTupleSpec	nullable()	Returns the same spec with the nullable flag enabled
JsTupleSpec	optional()	Returns the same spec with the optional flag enabled
JsSpecParser	parser()	Returns the deserializer used during the parsing process to parse an array of bytes or string
java.util.Set<JsErrorPair>	test(JsArray array)
java.util.Set<JsErrorPair>	test(JsPath parentPath, JsValue value)	verify if the given value satisfy this spec.

Methods inherited from class java.lang.Object

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

Method Detail

isRequired

public boolean isRequired()

Description copied from interface: JsSpec

Returns whether the key is optional.

Specified by:

isRequired in interface JsSpec

Returns:

whether the key is optional.

nullable

public JsTupleSpec nullable()

Description copied from interface: JsSpec

Returns the same spec with the nullable flag enabled

Specified by:

nullable in interface JsSpec

Returns:

the same spec with the nullable flag enabled

optional

public JsTupleSpec optional()

Description copied from interface: JsSpec

Returns the same spec with the optional flag enabled

Specified by:

optional in interface JsSpec

Returns:

the same spec with the optional flag enabled

parser

public JsSpecParser parser()

Description copied from interface: JsSpec

Returns the deserializer used during the parsing process to parse an array of bytes or string

Specified by:

parser in interface JsSpec

Returns:

the deserializer used during the parsing process to parse an array of bytes or string into a json value

test

public java.util.Set<JsErrorPair> test(JsPath parentPath,
                                       JsValue value)

Description copied from interface: JsSpec

verify if the given value satisfy this spec.

Specified by:

test in interface JsSpec

Parameters:

parentPath - the path where the tested value is located.

value - the tested value

Returns:

a set of path/error pairs

test

public java.util.Set<JsErrorPair> test(JsArray array)

Specified by:

test in interface JsArraySpec