com.boomi.util.json.schema

Interface ArrayTypeBuilder<P extends NestingBuilder>

Type Parameters:

P - The type of NestingBuilder that was used to create this builder. This is the type that will be returned by calling NestedBuilder.finish() on this builder.

All Superinterfaces:

CommonBuilder<ArrayTypeBuilder<P>>, NestedBuilder<P>, NestingBuilder

public interface ArrayTypeBuilder<P extends NestingBuilder>
extends NestedBuilder<P>, NestingBuilder, CommonBuilder<ArrayTypeBuilder<P>>

Builder class for building array type definitions. Array definitions allow "nesting" but are different than complex definitions. Complex types allow many nested definitions where array types allow only a single type definition describing the "items" that will appear in the array. Additionally, the definition is always created for the "items" property.

Method Summary

Modifier and Type	Method and Description
ElementTypeBuilder<ArrayTypeBuilder<P>>	buildDefinition() Builder method to create a type definition for this array.
ArrayTypeBuilder<P>	withMaxItems(int value) This method includes the "maxItems" attribute in the array type definition
ArrayTypeBuilder<P>	withMinItems(int value) This method includes the "minItems" attribute in the array type definition
ArrayTypeBuilder<P>	withUniqueItems(boolean value) This method includes the "uniqueItems" attribute in the array type definition

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

finish

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

Method Detail

withMaxItems

ArrayTypeBuilder<P> withMaxItems(int value)

This method includes the "maxItems" attribute in the array type definition

Parameters:

value - the value of the attribute

Returns:

the current ArrayTypeBuilder instance

withMinItems

ArrayTypeBuilder<P> withMinItems(int value)

This method includes the "minItems" attribute in the array type definition

Parameters:

value - the value of the attribute

Returns:

the current ArrayTypeBuilder instance

withUniqueItems

ArrayTypeBuilder<P> withUniqueItems(boolean value)

This method includes the "uniqueItems" attribute in the array type definition

Parameters:

value - the value of the attribute

Returns:

the current ArrayTypeBuilder instance

buildDefinition

ElementTypeBuilder<ArrayTypeBuilder<P>> buildDefinition()

Builder method to create a type definition for this array. The property will be added to the items node of the array represented by this builder instance. A call to NestedBuilder.finish() on the builder returned by this method will return the original builder instance. The definition will be replaced if this method is subsequently called again.

Returns:

ElementTypeBuilder instance that can be used to continue building on the type definition