JsObjSpec (json-values 11.7.0 API)

java.lang.Object
- jsonvalues.spec.JsObjSpec

All Implemented Interfaces:

JsSpec
```
public final class JsObjSpec
extends Object
implements JsSpec
```
Represents a specification of a Json object

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`getRequiredFields()`
`JsObjSpec`	`lenient()`
`JsObjSpec`	`nullable()` Returns the same spec with the nullable flag enabled
`static JsObjSpec`	`of(String key, JsSpec spec)`
`static JsObjSpec`	`of(String key1, JsSpec spec1, String key2, JsSpec spec2)`
`static JsObjSpec`	`of(String key1, JsSpec spec1, String key2, JsSpec spec2, String key3, JsSpec spec3)`
`static JsObjSpec`	`of(String key1, JsSpec spec1, String key2, JsSpec spec2, String key3, JsSpec spec3, String key4, JsSpec spec4)`
`static JsObjSpec`	`of(String key1, JsSpec spec1, String key2, JsSpec spec2, String key3, JsSpec spec3, String key4, JsSpec spec4, String key5, JsSpec spec5)`
`static JsObjSpec`	`of(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`	`of(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`	`of(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`	`of(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`	`of(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`	`of(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`	`of(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, String key12, JsSpec spec12)`
`static JsObjSpec`	`of(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, String key12, JsSpec spec12, String key13, JsSpec spec13)`
`static JsObjSpec`	`of(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, String key12, JsSpec spec12, String key13, JsSpec spec13, String key14, JsSpec spec14)`
`static JsObjSpec`	`of(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, String key12, JsSpec spec12, String key13, JsSpec spec13, String key14, JsSpec spec14, String key15, JsSpec spec15)`
`static JsObjSpec`	`of(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, String key12, JsSpec spec12, String key13, JsSpec spec13, String key14, JsSpec spec14, String key15, JsSpec spec15, String key16, JsSpec spec16)`
`static JsObjSpec`	of(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, String key12, JsSpec spec12, String key13, JsSpec spec13, String key14, JsSpec spec14, String key15, JsSpec spec15, String key16, JsSpec spec16, String key17, JsSpec spec17)
`static JsObjSpec`	of(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, String key12, JsSpec spec12, String key13, JsSpec spec13, String key14, JsSpec spec14, String key15, JsSpec spec15, String key16, JsSpec spec16, String key17, JsSpec spec17, String key18, JsSpec spec18)
`static JsObjSpec`	of(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, String key12, JsSpec spec12, String key13, JsSpec spec13, String key14, JsSpec spec14, String key15, JsSpec spec15, String key16, JsSpec spec16, String key17, JsSpec spec17, String key18, JsSpec spec18, String key19, JsSpec spec19)
`static JsObjSpec`	of(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, String key12, JsSpec spec12, String key13, JsSpec spec13, String key14, JsSpec spec14, String key15, JsSpec spec15, String key16, JsSpec spec16, String key17, JsSpec spec17, String key18, JsSpec spec18, String key19, JsSpec spec19, String key20, JsSpec spec20)
`JsSpecParser`	`parser()` Returns the deserializer used during the parsing process to parse an array of bytes or string
`JsObjSpec`	`set(String key, JsSpec spec)` add the given key spec to this
`JsObjSpec`	`suchThat(Predicate<JsObj> predicate)`
`Set<SpecError>`	`test(JsPath parentPath, JsValue value)` verify if the given value satisfy this spec.
`JsObjSpec`	`withAllOptKeys()`
`JsObjSpec`	`withOptKeys(List<String> optionals)`
`JsObjSpec`	`withOptKeys(String field, String... fields)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jsonvalues.spec.JsSpec
test

Method Detail

lenient
```
public JsObjSpec lenient()
```

of

public static JsObjSpec of(String key,
                           JsSpec spec)

of

public static JsObjSpec of(String key1,
                           JsSpec spec1,
                           String key2,
                           JsSpec spec2)

of

public static JsObjSpec of(String key1,
                           JsSpec spec1,
                           String key2,
                           JsSpec spec2,
                           String key3,
                           JsSpec spec3)

of

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

of

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

of

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

of

public static JsObjSpec of(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)

of

public static JsObjSpec of(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)

of

public static JsObjSpec of(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)

of

public static JsObjSpec of(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)

of

public static JsObjSpec of(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)

of

public static JsObjSpec of(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,
                           String key12,
                           JsSpec spec12)

of

public static JsObjSpec of(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,
                           String key12,
                           JsSpec spec12,
                           String key13,
                           JsSpec spec13,
                           String key14,
                           JsSpec spec14)

of

public static JsObjSpec of(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,
                           String key12,
                           JsSpec spec12,
                           String key13,
                           JsSpec spec13,
                           String key14,
                           JsSpec spec14,
                           String key15,
                           JsSpec spec15)

of

public static JsObjSpec of(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,
                           String key12,
                           JsSpec spec12,
                           String key13,
                           JsSpec spec13,
                           String key14,
                           JsSpec spec14,
                           String key15,
                           JsSpec spec15,
                           String key16,
                           JsSpec spec16)

of

public static JsObjSpec of(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,
                           String key12,
                           JsSpec spec12,
                           String key13,
                           JsSpec spec13,
                           String key14,
                           JsSpec spec14,
                           String key15,
                           JsSpec spec15,
                           String key16,
                           JsSpec spec16,
                           String key17,
                           JsSpec spec17)

of

public static JsObjSpec of(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,
                           String key12,
                           JsSpec spec12,
                           String key13,
                           JsSpec spec13,
                           String key14,
                           JsSpec spec14,
                           String key15,
                           JsSpec spec15,
                           String key16,
                           JsSpec spec16,
                           String key17,
                           JsSpec spec17,
                           String key18,
                           JsSpec spec18)

of

public static JsObjSpec of(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,
                           String key12,
                           JsSpec spec12,
                           String key13,
                           JsSpec spec13,
                           String key14,
                           JsSpec spec14,
                           String key15,
                           JsSpec spec15,
                           String key16,
                           JsSpec spec16,
                           String key17,
                           JsSpec spec17,
                           String key18,
                           JsSpec spec18,
                           String key19,
                           JsSpec spec19)

of

public static JsObjSpec of(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,
                           String key12,
                           JsSpec spec12,
                           String key13,
                           JsSpec spec13,
                           String key14,
                           JsSpec spec14,
                           String key15,
                           JsSpec spec15,
                           String key16,
                           JsSpec spec16,
                           String key17,
                           JsSpec spec17,
                           String key18,
                           JsSpec spec18,
                           String key19,
                           JsSpec spec19,
                           String key20,
                           JsSpec spec20)

of

public static JsObjSpec of(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,
                           String key12,
                           JsSpec spec12,
                           String key13,
                           JsSpec spec13)

suchThat

public JsObjSpec suchThat(Predicate<JsObj> predicate)

getRequiredFields

public List<String> getRequiredFields()

withAllOptKeys
```
public JsObjSpec withAllOptKeys()
```

withOptKeys

public JsObjSpec withOptKeys(String field,
                             String... fields)

withOptKeys

public JsObjSpec withOptKeys(List<String> optionals)

nullable
```
public JsObjSpec 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

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 Set<SpecError> 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

set

public JsObjSpec set(String key,
                     JsSpec spec)

add the given key spec to this

Parameters:: key - the key; spec - the spec
Returns:: a new object spec

Class JsObjSpec

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface jsonvalues.spec.JsSpec

Method Detail

lenient

of

of

of

of

of

of

of

of

of

of

of

of

of

of

of

of

of

of

of

of

suchThat

getRequiredFields

withAllOptKeys

withOptKeys

withOptKeys

nullable

parser

test

set