SchemaBuilderImpl

java.lang.Object
- com.boomi.util.json.schema.impl.SchemaBuilderImpl

All Implemented Interfaces:

CommonBuilder<SchemaBuilder>, ComplexTypeBuilder<SchemaBuilder>, NestedBuilder<SchemaBuilder>, NestingBuilder, SchemaBuilder
```
public class SchemaBuilderImpl
extends Object
implements SchemaBuilder
```
Base SchemaBuilder implementation Listing outstanding items here instead of in the API TODO add mark/unmark or current support to navigate previous builders TODO support customer ObjectMapper TODO support "additionalItems" for array type TODO support nested array definition for array type TODO support "definitions" TODO support "patternProperties" TODO support "dependencies" TODO support "allOf" TODO support "anyOf" TODO support "oneOf" TODO support "not" TODO support "default"

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.boomi.util.json.schema.impl.BoomiAnnotations`	`_annotations`
`protected ObjectNode`	`_root`
`protected static String`	`SCHEMA_DESCRIPTION`
`protected static String`	`SCHEMA_EXCLUSIVE_MAXIMUM`
`protected static String`	`SCHEMA_EXCLUSIVE_MINIMUM`
`protected static String`	`SCHEMA_FORMAT`
`protected static String`	`SCHEMA_MAX_ITEMS`
`protected static String`	`SCHEMA_MAX_LENGTH`
`protected static String`	`SCHEMA_MAX_PROPERTIES`
`protected static String`	`SCHEMA_MAXIMUM`
`protected static String`	`SCHEMA_MIN_ITEMS`
`protected static String`	`SCHEMA_MIN_LENGTH`
`protected static String`	`SCHEMA_MIN_PROPERTIES`
`protected static String`	`SCHEMA_MINIMUM`
`protected static String`	`SCHEMA_MULTIPLE_OF`
`protected static String`	`SCHEMA_PATTERN`
`protected static String`	`SCHEMA_REQUIRED`
`protected static String`	`SCHEMA_UNIQUE_ITEMS`

Constructor Summary

Constructors
Constructor and Description

SchemaBuilderImpl()
Creates a new instance using JSONUtil.getDefaultObjectMapper().

Constructors
Constructor and Description
`SchemaBuilderImpl()` Creates a new instance using `JSONUtil.getDefaultObjectMapper()`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addAttribute(String name, boolean value)`
`protected void`	`addAttribute(String name, int value)`
`protected void`	`addAttribute(String name, String value)`
`FieldSpecBuilder<T>`	`buildFieldSpec(String name)` Builder method to add a new "boomi_fieldSpec" annotation to the current object.
`ElementTypeBuilder<T>`	`buildProperty(String name)` Builder method to add a new property to the document.
`P`	`finish()` This method finalizes the current builder and the returns its parent builder (i.e, the builder that was used to create the current builder).
`ObjectNode`	`getObjectRoot()` This method returns the root `JsonNode` of the current builder.
`ObjectNode`	`getProperties()` This method returns the "properties" node of the object definition which is where any nestesd definitions should be defined.
`JsonNode`	`getSchema()` This method returns the schema document as a `JsonNode`.
`protected T`	`getThis()` Returns the current builder instance.
`void`	`reset()` This method removes any attributes that have been added and returns the schema document to its original state.
`T`	`withDescription(String value)` This method includes the "description" attribute in the current type definition.
`T`	`withId(String value)` This method includes the "id" attribute in the current type definition.
`T`	`withIgnoreForFilters(boolean value)` This method includes the "ignoreForFilters" boomi field spec annotation in the current type definition.
`T`	`withIgnoreForSelection(boolean value)` This method includes the "ignoreForSelection" boomi field spec annotation in the current type definition.
`T`	`withIgnoreForSort(boolean value)` This method includes the "ignoreForSort" boomi field spec annotation in the current type definition.
`T`	`withMaxProperties(int value)` This method includes the "maxProperties" attribute in the object type definition
`T`	`withMinProperties(int value)` This method includes the "minProperties" attribute in the object type definition
`T`	`withRequired(String... values)` This method includes the "required" attribute in the object type definition
`T`	`withTitle(String value)` This method includes the "title" attribute in the current type definition.

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

Methods inherited from interface com.boomi.util.json.schema.ComplexTypeBuilder
buildFieldSpec, buildProperty, withMaxProperties, withMinProperties, withRequired

Methods inherited from interface com.boomi.util.json.schema.NestingBuilder
getObjectRoot

Methods inherited from interface com.boomi.util.json.schema.CommonBuilder
withDescription, withId, withIgnoreForFilters, withIgnoreForSelection, withIgnoreForSort, withTitle

- Field Detail
  - SCHEMA_MIN_PROPERTIES
```
protected static final String SCHEMA_MIN_PROPERTIES
```
    See Also:
    
    Constant Field Values
  - SCHEMA_MAX_PROPERTIES
```
protected static final String SCHEMA_MAX_PROPERTIES
```
    See Also:
    
    Constant Field Values
  - SCHEMA_UNIQUE_ITEMS
```
protected static final String SCHEMA_UNIQUE_ITEMS
```
    See Also:
    
    Constant Field Values
  - SCHEMA_MULTIPLE_OF
```
protected static final String SCHEMA_MULTIPLE_OF
```
    See Also:
    
    Constant Field Values
  - SCHEMA_PATTERN
```
protected static final String SCHEMA_PATTERN
```
    See Also:
    
    Constant Field Values
  - SCHEMA_MIN_ITEMS
```
protected static final String SCHEMA_MIN_ITEMS
```
    See Also:
    
    Constant Field Values
  - SCHEMA_MAX_ITEMS
```
protected static final String SCHEMA_MAX_ITEMS
```
    See Also:
    
    Constant Field Values
  - SCHEMA_MIN_LENGTH
```
protected static final String SCHEMA_MIN_LENGTH
```
    See Also:
    
    Constant Field Values
  - SCHEMA_MAX_LENGTH
```
protected static final String SCHEMA_MAX_LENGTH
```
    See Also:
    
    Constant Field Values
  - SCHEMA_EXCLUSIVE_MAXIMUM
```
protected static final String SCHEMA_EXCLUSIVE_MAXIMUM
```
    See Also:
    
    Constant Field Values
  - SCHEMA_EXCLUSIVE_MINIMUM
```
protected static final String SCHEMA_EXCLUSIVE_MINIMUM
```
    See Also:
    
    Constant Field Values
  - SCHEMA_MINIMUM
```
protected static final String SCHEMA_MINIMUM
```
    See Also:
    
    Constant Field Values
  - SCHEMA_MAXIMUM
```
protected static final String SCHEMA_MAXIMUM
```
    See Also:
    
    Constant Field Values
  - SCHEMA_FORMAT
```
protected static final String SCHEMA_FORMAT
```
    See Also:
    
    Constant Field Values
  - SCHEMA_REQUIRED
```
protected static final String SCHEMA_REQUIRED
```
    See Also:
    
    Constant Field Values
  - SCHEMA_DESCRIPTION
```
protected static final String SCHEMA_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - _root
```
protected final ObjectNode _root
```
  - _annotations
```
protected final com.boomi.util.json.schema.impl.BoomiAnnotations _annotations
```
- Constructor Detail
  - SchemaBuilderImpl
```
public SchemaBuilderImpl()
```
    Creates a new instance using JSONUtil.getDefaultObjectMapper(). Sets the schema type to object and the $schema to JSONUtil.SchemaVersion#DRAFT_04.
- Method Detail
  - getSchema
```
public JsonNode getSchema()
```
    Description copied from interface: SchemaBuilder
    
    This method returns the schema document as a JsonNode. The method can be called multiple times and will return the current state of the schema.
    
    Specified by:
    
    getSchema in interface SchemaBuilder
    
    Returns:
    
    the JSON schema document
  - reset
```
public void reset()
```
    Description copied from interface: SchemaBuilder
    
    This method removes any attributes that have been added and returns the schema document to its original state.
    
    Specified by:
    
    reset in interface SchemaBuilder
  - buildFieldSpec
```
public FieldSpecBuilder<T> buildFieldSpec(String name)
```
    Description copied from interface: ComplexTypeBuilder
    
    Builder method to add a new "boomi_fieldSpec" annotation to the current object. The "annotations", "boomi_fieldSpec", and "fields" properties will be created as part of this operation if they do not exist or preserved if they are already present. The field spec will be replaced if this method is called multiple times with the same name.
    
    Specified by:
    
    buildFieldSpec in interface ComplexTypeBuilder<T extends ComplexTypeBuilder<T>>
    
    Parameters:
    
    name - the name of the field spec
    
    Returns:
    
    FieldSpecBuilder instance that can be used to continue building on the field spec
  - getProperties
```
public ObjectNode getProperties()
```
    This method returns the "properties" node of the object definition which is where any nestesd definitions should be defined.
    
    Returns:
    
    the properties node
  - buildProperty
```
public ElementTypeBuilder<T> buildProperty(String name)
```
    Description copied from interface: ComplexTypeBuilder
    
    Builder method to add a new property to the document. The property will be added to the properties node of the object represented by this ComplexTypeBuilder instance. The method will return an ElementTypeBuilder instance that can be used to obtain a builder for desired property type. A call to NestedBuilder.finish() on the type specific builder will return the original builder instance. The property will be replaced if this method is called multiple times with the same name.
    
    Specified by:
    
    buildProperty in interface ComplexTypeBuilder<T extends ComplexTypeBuilder<T>>
    
    Parameters:
    
    name - the name of the property
    
    Returns:
    
    ArrayTypeBuilder instance that can be used to continue building on the array property
  - withRequired
```
public T withRequired(String... values)
```
    Description copied from interface: ComplexTypeBuilder
    
    This method includes the "required" attribute in the object type definition
    
    Specified by:
    
    withRequired in interface ComplexTypeBuilder<T extends ComplexTypeBuilder<T>>
    
    Parameters:
    
    values - the value array of the attribute
    
    Returns:
    
    the current ObjectTypeBuilder instance
  - withMaxProperties
```
public T withMaxProperties(int value)
```
    Description copied from interface: ComplexTypeBuilder
    
    This method includes the "maxProperties" attribute in the object type definition
    
    Specified by:
    
    withMaxProperties in interface ComplexTypeBuilder<T extends ComplexTypeBuilder<T>>
    
    Returns:
    
    the current ObjectTypeBuilder instance
  - withMinProperties
```
public T withMinProperties(int value)
```
    Description copied from interface: ComplexTypeBuilder
    
    This method includes the "minProperties" attribute in the object type definition
    
    Specified by:
    
    withMinProperties in interface ComplexTypeBuilder<T extends ComplexTypeBuilder<T>>
    
    Returns:
    
    the current ObjectTypeBuilder instance
  - finish
```
public P finish()
```
    Description copied from interface: NestedBuilder
    
    This method finalizes the current builder and the returns its parent builder (i.e, the builder that was used to create the current builder).
    
    Specified by:
    
    finish in interface NestedBuilder<P extends NestingBuilder>
    
    Returns:
    
    the parent builder of type
  - withId
```
public T withId(String value)
```
    Description copied from interface: CommonBuilder
    
    This method includes the "id" attribute in the current type definition. Calling this method multiple times will overwrite any previous attribute values.
    
    Specified by:
    
    withId in interface CommonBuilder<T extends CommonBuilder<T>>
    
    Parameters:
    
    value - the value of the attribute
    
    Returns:
    
    the current builder instance of type
  - withDescription
```
public T withDescription(String value)
```
    Description copied from interface: CommonBuilder
    
    This method includes the "description" attribute in the current type definition. Calling this method multiple times will overwrite any previous attribute values.
    
    Specified by:
    
    withDescription in interface CommonBuilder<T extends CommonBuilder<T>>
    
    Parameters:
    
    value - the value of the attribute
    
    Returns:
    
    the current builder instance of type
  - withIgnoreForFilters
```
public T withIgnoreForFilters(boolean value)
```
    Description copied from interface: CommonBuilder
    
    This method includes the "ignoreForFilters" boomi field spec annotation in the current type definition. The "annotations" and "boomi_fieldSpec" properties will be created as part of this operation if they do not exist or preserved if they are already present. Calling this method multiple times will overwrite any previous values for the field spec.
    
    Specified by:
    
    withIgnoreForFilters in interface CommonBuilder<T extends CommonBuilder<T>>
    
    Parameters:
    
    value - the value of the attribute
    
    Returns:
    
    the current builder instance of type
  - withIgnoreForSelection
```
public T withIgnoreForSelection(boolean value)
```
    Description copied from interface: CommonBuilder
    
    This method includes the "ignoreForSelection" boomi field spec annotation in the current type definition. The "annotations" and "boomi_fieldSpec" properties will be created as part of this operation if they do not exist or preserved if they are already present. Calling this method multiple times will overwrite any previous values for the field spec.
    
    Specified by:
    
    withIgnoreForSelection in interface CommonBuilder<T extends CommonBuilder<T>>
    
    Parameters:
    
    value - the value of the attribute
    
    Returns:
    
    the current builder instance of type
  - withIgnoreForSort
```
public T withIgnoreForSort(boolean value)
```
    Description copied from interface: CommonBuilder
    
    This method includes the "ignoreForSort" boomi field spec annotation in the current type definition. The "annotations" and "boomi_fieldSpec" properties will be created as part of this operation if they do not exist or preserved if they are already present. Calling this method multiple times will overwrite any previous values for the field spec.
    
    Specified by:
    
    withIgnoreForSort in interface CommonBuilder<T extends CommonBuilder<T>>
    
    Parameters:
    
    value - the value of the attribute
    
    Returns:
    
    the current builder instance of type
  - getObjectRoot
```
public ObjectNode getObjectRoot()
```
    Description copied from interface: NestingBuilder
    
    This method returns the root JsonNode of the current builder.
    
    Specified by:
    
    getObjectRoot in interface NestingBuilder
    
    Returns:
    
    the root node
  - withTitle
```
public T withTitle(String value)
```
    Description copied from interface: CommonBuilder
    
    This method includes the "title" attribute in the current type definition. Calling this method multiple times will overwrite any previous attribute values.
    
    Specified by:
    
    withTitle in interface CommonBuilder<T extends CommonBuilder<T>>
    
    Parameters:
    
    value - the value of the attribute
    
    Returns:
    
    the current builder instance of type
  - addAttribute
```
protected void addAttribute(String name,
                            int value)
```
  - addAttribute
```
protected void addAttribute(String name,
                            String value)
```
  - addAttribute
```
protected void addAttribute(String name,
                            boolean value)
```
  - getThis
```
protected final T getThis()
```
    Returns the current builder instance. return this; has some weirdness because of the generic typing
    
    Returns:
    
    the current builder instance

Class SchemaBuilderImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.boomi.util.json.schema.ComplexTypeBuilder

Methods inherited from interface com.boomi.util.json.schema.NestingBuilder

Methods inherited from interface com.boomi.util.json.schema.CommonBuilder

Field Detail

SCHEMA_MIN_PROPERTIES

SCHEMA_MAX_PROPERTIES

SCHEMA_UNIQUE_ITEMS

SCHEMA_MULTIPLE_OF

SCHEMA_PATTERN

SCHEMA_MIN_ITEMS

SCHEMA_MAX_ITEMS

SCHEMA_MIN_LENGTH

SCHEMA_MAX_LENGTH

SCHEMA_EXCLUSIVE_MAXIMUM

SCHEMA_EXCLUSIVE_MINIMUM

SCHEMA_MINIMUM

SCHEMA_MAXIMUM

SCHEMA_FORMAT

SCHEMA_REQUIRED

SCHEMA_DESCRIPTION

_root

_annotations

Constructor Detail

SchemaBuilderImpl

Method Detail

getSchema

reset

buildFieldSpec

getProperties

buildProperty

withRequired

withMaxProperties

withMinProperties

finish

withId

withDescription

withIgnoreForFilters

withIgnoreForSelection

withIgnoreForSort

getObjectRoot

withTitle

addAttribute

addAttribute

addAttribute

getThis