com.boomi.util.json.schema

Interface CommonBuilder<T>

Type Parameters:

T - type of the current builder

All Known Subinterfaces:

ArrayTypeBuilder<P>, BooleanTypeBuilder<P>, ComplexTypeBuilder<T>, NullTypeBuilder<P>, NumericTypeBuilder<P>, ObjectTypeBuilder<P>, SchemaBuilder, SimpleTypeBuilder<T,P>, StringTypeBuilder<P>

All Known Implementing Classes:

SchemaBuilderImpl

public interface CommonBuilder<T>

Builder class that defines operations common to all builders. These actions can be performed using SimpleTypeBuilder, ComplexTypeBuilder, ArrayTypeBuilder implementations and are always "in context" (i.e., can be chained to any other builder method).

Method Summary

Modifier and Type	Method and Description
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	withTitle(String value) This method includes the "title" attribute in the current type definition.

Method Detail

withId

T withId(String value)

This method includes the "id" attribute in the current type definition. Calling this method multiple times will overwrite any previous attribute values.

Parameters:

value - the value of the attribute

Returns:

the current builder instance of type

withDescription

T withDescription(String value)

This method includes the "description" attribute in the current type definition. Calling this method multiple times will overwrite any previous attribute values.

Parameters:

value - the value of the attribute

Returns:

the current builder instance of type

withTitle

T withTitle(String value)

This method includes the "title" attribute in the current type definition. Calling this method multiple times will overwrite any previous attribute values.

Parameters:

value - the value of the attribute

Returns:

the current builder instance of type

withIgnoreForFilters

T withIgnoreForFilters(boolean value)

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.

Parameters:

value - the value of the attribute

Returns:

the current builder instance of type

withIgnoreForSelection

T withIgnoreForSelection(boolean value)

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.

Parameters:

value - the value of the attribute

Returns:

the current builder instance of type

withIgnoreForSort

T withIgnoreForSort(boolean value)

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.

Parameters:

value - the value of the attribute

Returns:

the current builder instance of type