Package io.deephaven.json

Class ObjectValue

java.lang.Object

io.deephaven.json.Value

io.deephaven.json.ValueRestrictedUniverseBase

io.deephaven.json.ObjectValue

@Immutable
public abstract class ObjectValue
extends ValueRestrictedUniverseBase

Processes a JSON object as set of named fields.

For example, the following might be modelled as an object with a String "name" field, an int "age" field, and a double "height" field:

 {
     "name": "Foo",
     "age": 42,
     "height": 6.5
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ObjectValue.Builder

Nested classes/interfaces inherited from class io.deephaven.json.Value

Value.Visitor<T>

Constructor Summary

Constructors

Constructor	Description
ObjectValue()

Method Summary

Modifier and Type	Method	Description
Set<JsonValueTypes>	allowedTypes()	The allowed types.
boolean	allowUnknownFields()	If unknown fields are allowed.
static ObjectValue.Builder	builder()
abstract Set<ObjectField>	fields()	The fields.
static ObjectValue	lenient(Map<String,Value> fields)	The lenient object options.
static ObjectValue	standard(Map<String,Value> fields)	The standard object options.
static ObjectValue	strict(Map<String,Value> fields)	The strict object options.
final <T> T	walk(Value.Visitor<T> visitor)

Methods inherited from class io.deephaven.json.Value

allowMissing, array, field, skip

Methods inherited from class java.lang.Object

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

Constructor Details

ObjectValue

public ObjectValue()

Method Details

builder

public static ObjectValue.Builder builder()

lenient

public static ObjectValue lenient(Map<String,Value> fields)

The lenient object options. Allows missing, accepts JsonValueTypes.objectOrNull(), and allows unknown fields. The object fields are constructed with ObjectField.caseSensitive() as false and ObjectField.repeatedBehavior() as ObjectField.RepeatedBehavior.USE_FIRST.

Parameters:

fields - the fields

Returns:

the lenient object options

standard

public static ObjectValue standard(Map<String,Value> fields)

The standard object options. Allows missing, accepts JsonValueTypes.objectOrNull(), and allows unknown fields. The object fields are constructed with ObjectField.of(String, Value).

Parameters:

fields - the fields

Returns:

the standard object options

strict

public static ObjectValue strict(Map<String,Value> fields)

The strict object options. Disallows missing, accepts JsonValueTypes.object(), and disallows unknown fields. The object fields are constructed with ObjectField.of(String, Value).

Parameters:

fields - the fields

Returns:

the strict object options

fields

public abstract Set<ObjectField> fields()

The fields.

allowUnknownFields

@Default
public boolean allowUnknownFields()

If unknown fields are allowed. By default is true.

allowedTypes

@Default
public Set<JsonValueTypes> allowedTypes()

The allowed types. Must be a subset of JsonValueTypes.objectOrNull(). By default is JsonValueTypes.objectOrNull().

Specified by:

allowedTypes in class Value

walk

public final <T> T walk(Value.Visitor<T> visitor)

Specified by:

walk in class Value