Package io.deephaven.json

Class ObjectField

java.lang.Object
io.deephaven.json.ObjectField
@Immutable public abstract class ObjectField extends Object

  • Constructor Details

    • ObjectField

      public ObjectField()

  • Method Details

    • builder

      public static ObjectField.Builder builder()

    • of

      public static ObjectField of(String name, Value options)
      Creates a field with a single name. Equivalent to builder().name(name).options(options).build().
      Parameters:
      name - the name
      options - the options
      Returns:
      the field options

    • name

      public abstract String name()
      The canonical field name.

    • options

      public abstract Value options()
      The value options.

    • aliases

      public abstract Set<String> aliases()
      The field name aliases.

    • caseSensitive

      @Default public boolean caseSensitive()
      If the field name and aliases should be compared using case-sensitive equality. By default is true.

    • repeatedBehavior

      @Default public ObjectField.RepeatedBehavior repeatedBehavior()
      The behavior when a repeated field is encountered. By default is ObjectField.RepeatedBehavior.ERROR.

    • arrayGroup

      public abstract Optional<Object> arrayGroup()
      The array group for this field. This is useful in scenarios where this field's array is guaranteed to have the same cardinality as one or more other array fields. For example, in the following snippet, we might model "prices" and "quantities" as having the same array group: 
       {
   "prices": [1.1, 2.2, 3.3],
   "quantities": [9, 5, 42]
 }