com.boomi.util.json.schema

Interface SimpleTypeBuilder<T extends SimpleTypeBuilder<T,P>,P extends NestingBuilder>

All Superinterfaces:

CommonBuilder<T>, NestedBuilder<P>

All Known Subinterfaces:

BooleanTypeBuilder<P>, NullTypeBuilder<P>, NumericTypeBuilder<P>, StringTypeBuilder<P>

public interface SimpleTypeBuilder<T extends SimpleTypeBuilder<T,P>,P extends NestingBuilder>
extends CommonBuilder<T>, NestedBuilder<P>

Builder class for building "simple" types. Simple types in a JSON schema are types other than object and array (i.e., string, boolean, number, integer, and null). This API contains the actions that are common for all simple type builders. Actions specific to individual simple types are defined in the type specific builder APIs.

See Also:

StringTypeBuilder, BooleanTypeBuilder, NumericTypeBuilder, NullTypeBuilder

Method Summary

Modifier and Type	Method and Description
T	withBoomiDataType(DataType dataType, String format) This method will add the "boomi_dataFormat" annotation to the simple type definition represented by this builder.

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

withDescription, withId, withIgnoreForFilters, withIgnoreForSelection, withIgnoreForSort, withTitle

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

finish

Method Detail

withBoomiDataType

T withBoomiDataType(DataType dataType,
                    String format)

This method will add the "boomi_dataFormat" annotation to the simple type definition represented by this builder. The "annotations" property will be created as part of this operation if it does not exist or preserved if it is already present.

Parameters:

dataType - the boomi data type

format - the format of the data type

Returns:

the current SimpleTypeBuilder instance