Package jsonvalues.spec

Class JsObjSpec

java.lang.Object

jsonvalues.spec.JsObjSpec

All Implemented Interfaces:

JsSpec

public class JsObjSpec
extends Object
implements JsSpec

Constructor Summary

Constructors

Constructor	Description
JsObjSpec(io.vavr.collection.Map<String,JsSpec> bindings, boolean required, boolean nullable, boolean strict)

Method Summary

Modifier and Type	Method	Description
boolean	isRequired()
static JsObjSpec	lenient(String key, JsSpec spec)
static JsObjSpec	lenient(String key, JsSpec spec, String key1, JsSpec spec1)
static JsObjSpec	lenient(String key, JsSpec spec, String key1, JsSpec spec1, String key2, JsSpec spec2)
static JsObjSpec	lenient(String key, JsSpec spec, String key1, JsSpec spec1, String key2, JsSpec spec2, String key3, JsSpec spec3)
static JsObjSpec	lenient(String key, JsSpec spec, String key1, JsSpec spec1, String key2, JsSpec spec2, String key3, JsSpec spec3, String key4, JsSpec spec4)
static JsObjSpec	lenient(String key, JsSpec spec, String key1, JsSpec spec1, String key2, JsSpec spec2, String key3, JsSpec spec3, String key4, JsSpec spec4, String key5, JsSpec spec5)
static JsObjSpec	lenient(String key, JsSpec spec, String key1, JsSpec spec1, String key2, JsSpec spec2, String key3, JsSpec spec3, String key4, JsSpec spec4, String key5, JsSpec spec5, String key6, JsSpec spec6)
static JsObjSpec	lenient(String key, JsSpec spec, String key1, JsSpec spec1, String key2, JsSpec spec2, String key3, JsSpec spec3, String key4, JsSpec spec4, String key5, JsSpec spec5, String key6, JsSpec spec6, String key7, JsSpec spec7)
static JsObjSpec	lenient(String key, JsSpec spec, String key1, JsSpec spec1, String key2, JsSpec spec2, String key3, JsSpec spec3, String key4, JsSpec spec4, String key5, JsSpec spec5, String key6, JsSpec spec6, String key7, JsSpec spec7, String key8, JsSpec spec8)
static JsObjSpec	lenient(String key, JsSpec spec, String key1, JsSpec spec1, String key2, JsSpec spec2, String key3, JsSpec spec3, String key4, JsSpec spec4, String key5, JsSpec spec5, String key6, JsSpec spec6, String key7, JsSpec spec7, String key8, JsSpec spec8, String key9, JsSpec spec9)
static JsObjSpec	lenient(String key, JsSpec spec, String key1, JsSpec spec1, String key2, JsSpec spec2, String key3, JsSpec spec3, String key4, JsSpec spec4, String key5, JsSpec spec5, String key6, JsSpec spec6, String key7, JsSpec spec7, String key8, JsSpec spec8, String key9, JsSpec spec9, String key10, JsSpec spec10)
static JsObjSpec	lenient(String key, JsSpec spec, String key1, JsSpec spec1, String key2, JsSpec spec2, String key3, JsSpec spec3, String key4, JsSpec spec4, String key5, JsSpec spec5, String key6, JsSpec spec6, String key7, JsSpec spec7, String key8, JsSpec spec8, String key9, JsSpec spec9, String key10, JsSpec spec10, String key11, JsSpec spec11)
static JsObjSpec	lenient(JsSpecPair pair, JsSpecPair... others)
JsObjSpec	nullable()
JsObjSpec	optional()
JsSpecParser	parser()
static JsObjSpec	strict(String key, JsSpec spec)
static JsObjSpec	strict(String key, JsSpec spec, String key1, JsSpec spec1)
static JsObjSpec	strict(String key, JsSpec spec, String key1, JsSpec spec1, String key2, JsSpec spec2)
static JsObjSpec	strict(String key, JsSpec spec, String key1, JsSpec spec1, String key2, JsSpec spec2, String key3, JsSpec spec3)
static JsObjSpec	strict(String key, JsSpec spec, String key1, JsSpec spec1, String key2, JsSpec spec2, String key3, JsSpec spec3, String key4, JsSpec spec4)
static JsObjSpec	strict(String key, JsSpec spec, String key1, JsSpec spec1, String key2, JsSpec spec2, String key3, JsSpec spec3, String key4, JsSpec spec4, String key5, JsSpec spec5)
static JsObjSpec	strict(String key, JsSpec spec, String key1, JsSpec spec1, String key2, JsSpec spec2, String key3, JsSpec spec3, String key4, JsSpec spec4, String key5, JsSpec spec5, String key6, JsSpec spec6)
static JsObjSpec	strict(String key, JsSpec spec, String key1, JsSpec spec1, String key2, JsSpec spec2, String key3, JsSpec spec3, String key4, JsSpec spec4, String key5, JsSpec spec5, String key6, JsSpec spec6, String key7, JsSpec spec7)
static JsObjSpec	strict(String key, JsSpec spec, String key1, JsSpec spec1, String key2, JsSpec spec2, String key3, JsSpec spec3, String key4, JsSpec spec4, String key5, JsSpec spec5, String key6, JsSpec spec6, String key7, JsSpec spec7, String key8, JsSpec spec8)
static JsObjSpec	strict(String key, JsSpec spec, String key1, JsSpec spec1, String key2, JsSpec spec2, String key3, JsSpec spec3, String key4, JsSpec spec4, String key5, JsSpec spec5, String key6, JsSpec spec6, String key7, JsSpec spec7, String key8, JsSpec spec8, String key9, JsSpec spec9)
static JsObjSpec	strict(String key, JsSpec spec, String key1, JsSpec spec1, String key2, JsSpec spec2, String key3, JsSpec spec3, String key4, JsSpec spec4, String key5, JsSpec spec5, String key6, JsSpec spec6, String key7, JsSpec spec7, String key8, JsSpec spec8, String key9, JsSpec spec9, String key10, JsSpec spec10)
static JsObjSpec	strict(String key, JsSpec spec, String key1, JsSpec spec1, String key2, JsSpec spec2, String key3, JsSpec spec3, String key4, JsSpec spec4, String key5, JsSpec spec5, String key6, JsSpec spec6, String key7, JsSpec spec7, String key8, JsSpec spec8, String key9, JsSpec spec9, String key10, JsSpec spec10, String key11, JsSpec spec11)
static JsObjSpec	strict(JsSpecPair pair, JsSpecPair... others)
Set<JsErrorPair>	test(JsObj obj)
Set<JsErrorPair>	test(JsPath parentPath, JsValue value)

Methods inherited from class java.lang.Object

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

Constructor Detail

JsObjSpec

public JsObjSpec(io.vavr.collection.Map<String,JsSpec> bindings,
                 boolean required,
                 boolean nullable,
                 boolean strict)

Method Detail

isRequired

public boolean isRequired()

Specified by:

isRequired in interface JsSpec

Returns:

whether or not the key is optional.

optional

public JsObjSpec optional()

Specified by:

optional in interface JsSpec

Returns:

the same spec with the optional flag enabled

parser

public JsSpecParser parser()

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 Set<JsErrorPair> test(JsObj obj)

nullable

public JsObjSpec nullable()

Specified by:

nullable in interface JsSpec

Returns:

the same spec with the nullable flag enabled

test

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

Specified by:

test in interface JsSpec

strict

public static JsObjSpec strict(JsSpecPair pair,
                               JsSpecPair... others)

lenient

public static JsObjSpec lenient(JsSpecPair pair,
                                JsSpecPair... others)

strict

public static JsObjSpec strict(String key,
                               JsSpec spec)

lenient

public static JsObjSpec lenient(String key,
                                JsSpec spec)

strict

public static JsObjSpec strict(String key,
                               JsSpec spec,
                               String key1,
                               JsSpec spec1)

lenient

public static JsObjSpec lenient(String key,
                                JsSpec spec,
                                String key1,
                                JsSpec spec1)

strict

public static JsObjSpec strict(String key,
                               JsSpec spec,
                               String key1,
                               JsSpec spec1,
                               String key2,
                               JsSpec spec2)

lenient

public static JsObjSpec lenient(String key,
                                JsSpec spec,
                                String key1,
                                JsSpec spec1,
                                String key2,
                                JsSpec spec2)

strict

public static JsObjSpec strict(String key,
                               JsSpec spec,
                               String key1,
                               JsSpec spec1,
                               String key2,
                               JsSpec spec2,
                               String key3,
                               JsSpec spec3)

lenient

public static JsObjSpec lenient(String key,
                                JsSpec spec,
                                String key1,
                                JsSpec spec1,
                                String key2,
                                JsSpec spec2,
                                String key3,
                                JsSpec spec3)

strict

public static JsObjSpec strict(String key,
                               JsSpec spec,
                               String key1,
                               JsSpec spec1,
                               String key2,
                               JsSpec spec2,
                               String key3,
                               JsSpec spec3,
                               String key4,
                               JsSpec spec4)

lenient

public static JsObjSpec lenient(String key,
                                JsSpec spec,
                                String key1,
                                JsSpec spec1,
                                String key2,
                                JsSpec spec2,
                                String key3,
                                JsSpec spec3,
                                String key4,
                                JsSpec spec4)

strict

public static JsObjSpec strict(String key,
                               JsSpec spec,
                               String key1,
                               JsSpec spec1,
                               String key2,
                               JsSpec spec2,
                               String key3,
                               JsSpec spec3,
                               String key4,
                               JsSpec spec4,
                               String key5,
                               JsSpec spec5)

lenient

public static JsObjSpec lenient(String key,
                                JsSpec spec,
                                String key1,
                                JsSpec spec1,
                                String key2,
                                JsSpec spec2,
                                String key3,
                                JsSpec spec3,
                                String key4,
                                JsSpec spec4,
                                String key5,
                                JsSpec spec5)

strict

public static JsObjSpec strict(String key,
                               JsSpec spec,
                               String key1,
                               JsSpec spec1,
                               String key2,
                               JsSpec spec2,
                               String key3,
                               JsSpec spec3,
                               String key4,
                               JsSpec spec4,
                               String key5,
                               JsSpec spec5,
                               String key6,
                               JsSpec spec6)

lenient

public static JsObjSpec lenient(String key,
                                JsSpec spec,
                                String key1,
                                JsSpec spec1,
                                String key2,
                                JsSpec spec2,
                                String key3,
                                JsSpec spec3,
                                String key4,
                                JsSpec spec4,
                                String key5,
                                JsSpec spec5,
                                String key6,
                                JsSpec spec6)

strict

public static JsObjSpec strict(String key,
                               JsSpec spec,
                               String key1,
                               JsSpec spec1,
                               String key2,
                               JsSpec spec2,
                               String key3,
                               JsSpec spec3,
                               String key4,
                               JsSpec spec4,
                               String key5,
                               JsSpec spec5,
                               String key6,
                               JsSpec spec6,
                               String key7,
                               JsSpec spec7)

lenient

public static JsObjSpec lenient(String key,
                                JsSpec spec,
                                String key1,
                                JsSpec spec1,
                                String key2,
                                JsSpec spec2,
                                String key3,
                                JsSpec spec3,
                                String key4,
                                JsSpec spec4,
                                String key5,
                                JsSpec spec5,
                                String key6,
                                JsSpec spec6,
                                String key7,
                                JsSpec spec7)

strict

public static JsObjSpec strict(String key,
                               JsSpec spec,
                               String key1,
                               JsSpec spec1,
                               String key2,
                               JsSpec spec2,
                               String key3,
                               JsSpec spec3,
                               String key4,
                               JsSpec spec4,
                               String key5,
                               JsSpec spec5,
                               String key6,
                               JsSpec spec6,
                               String key7,
                               JsSpec spec7,
                               String key8,
                               JsSpec spec8)

lenient

public static JsObjSpec lenient(String key,
                                JsSpec spec,
                                String key1,
                                JsSpec spec1,
                                String key2,
                                JsSpec spec2,
                                String key3,
                                JsSpec spec3,
                                String key4,
                                JsSpec spec4,
                                String key5,
                                JsSpec spec5,
                                String key6,
                                JsSpec spec6,
                                String key7,
                                JsSpec spec7,
                                String key8,
                                JsSpec spec8)

strict

public static JsObjSpec strict(String key,
                               JsSpec spec,
                               String key1,
                               JsSpec spec1,
                               String key2,
                               JsSpec spec2,
                               String key3,
                               JsSpec spec3,
                               String key4,
                               JsSpec spec4,
                               String key5,
                               JsSpec spec5,
                               String key6,
                               JsSpec spec6,
                               String key7,
                               JsSpec spec7,
                               String key8,
                               JsSpec spec8,
                               String key9,
                               JsSpec spec9)

lenient

public static JsObjSpec lenient(String key,
                                JsSpec spec,
                                String key1,
                                JsSpec spec1,
                                String key2,
                                JsSpec spec2,
                                String key3,
                                JsSpec spec3,
                                String key4,
                                JsSpec spec4,
                                String key5,
                                JsSpec spec5,
                                String key6,
                                JsSpec spec6,
                                String key7,
                                JsSpec spec7,
                                String key8,
                                JsSpec spec8,
                                String key9,
                                JsSpec spec9)

strict

public static JsObjSpec strict(String key,
                               JsSpec spec,
                               String key1,
                               JsSpec spec1,
                               String key2,
                               JsSpec spec2,
                               String key3,
                               JsSpec spec3,
                               String key4,
                               JsSpec spec4,
                               String key5,
                               JsSpec spec5,
                               String key6,
                               JsSpec spec6,
                               String key7,
                               JsSpec spec7,
                               String key8,
                               JsSpec spec8,
                               String key9,
                               JsSpec spec9,
                               String key10,
                               JsSpec spec10)

lenient

public static JsObjSpec lenient(String key,
                                JsSpec spec,
                                String key1,
                                JsSpec spec1,
                                String key2,
                                JsSpec spec2,
                                String key3,
                                JsSpec spec3,
                                String key4,
                                JsSpec spec4,
                                String key5,
                                JsSpec spec5,
                                String key6,
                                JsSpec spec6,
                                String key7,
                                JsSpec spec7,
                                String key8,
                                JsSpec spec8,
                                String key9,
                                JsSpec spec9,
                                String key10,
                                JsSpec spec10)

strict

public static JsObjSpec strict(String key,
                               JsSpec spec,
                               String key1,
                               JsSpec spec1,
                               String key2,
                               JsSpec spec2,
                               String key3,
                               JsSpec spec3,
                               String key4,
                               JsSpec spec4,
                               String key5,
                               JsSpec spec5,
                               String key6,
                               JsSpec spec6,
                               String key7,
                               JsSpec spec7,
                               String key8,
                               JsSpec spec8,
                               String key9,
                               JsSpec spec9,
                               String key10,
                               JsSpec spec10,
                               String key11,
                               JsSpec spec11)

lenient

public static JsObjSpec lenient(String key,
                                JsSpec spec,
                                String key1,
                                JsSpec spec1,
                                String key2,
                                JsSpec spec2,
                                String key3,
                                JsSpec spec3,
                                String key4,
                                JsSpec spec4,
                                String key5,
                                JsSpec spec5,
                                String key6,
                                JsSpec spec6,
                                String key7,
                                JsSpec spec7,
                                String key8,
                                JsSpec spec8,
                                String key9,
                                JsSpec spec9,
                                String key10,
                                JsSpec spec10,
                                String key11,
                                JsSpec spec11)