com.boomi.util.json.schema

Interface NumericTypeBuilder<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<NumericTypeBuilder<P>>, NestedBuilder<P>, SimpleTypeBuilder<NumericTypeBuilder<P>,P>

public interface NumericTypeBuilder<P extends NestingBuilder>
extends SimpleTypeBuilder<NumericTypeBuilder<P>,P>

Builder class for building numeric type definitions. This includes definitions of type "number" and "integer".

Method Summary

Modifier and Type	Method and Description
NumericTypeBuilder<P>	withExclusiveMaximum(int value) This method includes the "maximum" and "exclusiveMaximum" attributes in the numeric type definition since both are required when using exclusive maximum.
NumericTypeBuilder<P>	withExclusiveMinimum(int value) This method includes the "minimum" and "exclusiveMinimum" attributes in the numeric type definition since both are required when using exclusive minimum.
NumericTypeBuilder<P>	withMaximum(int value) This method includes the "maximum" attribute in the numeric type definition
NumericTypeBuilder<P>	withMinimum(int value) This method includes the "minimum" attribute in the numeric type definition
NumericTypeBuilder<P>	withMultipleOf(int value) This method includes the "multipleOf" attribute in the numeric type definition

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

withBoomiDataType

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

withMaximum

NumericTypeBuilder<P> withMaximum(int value)

This method includes the "maximum" attribute in the numeric type definition

Parameters:

value - the value of the attribute

Returns:

the current NumericTypeBuilder instance

withExclusiveMaximum

NumericTypeBuilder<P> withExclusiveMaximum(int value)

This method includes the "maximum" and "exclusiveMaximum" attributes in the numeric type definition since both are required when using exclusive maximum. The exclusive maximum will be set to true and the maximum will be set to the specified value. The default exclusiveMaximum value is false so withMaximum(int) should be used for inclusive maximum values.

Parameters:

value - the value of the attribute

Returns:

the current NumericTypeBuilder instance

withMinimum

NumericTypeBuilder<P> withMinimum(int value)

This method includes the "minimum" attribute in the numeric type definition

Parameters:

value - the value of the attribute

Returns:

the current NumericTypeBuilder instance

withExclusiveMinimum

NumericTypeBuilder<P> withExclusiveMinimum(int value)

This method includes the "minimum" and "exclusiveMinimum" attributes in the numeric type definition since both are required when using exclusive minimum. The exclusive minimum will be set to true and the minimum will be set to the specified value. The default exclusiveMinimum value is false so withMaximum(int) should be used for inclusive minimum values.

Parameters:

value - the value of the attribute

Returns:

the current NumericTypeBuilder instance

withMultipleOf

NumericTypeBuilder<P> withMultipleOf(int value)

This method includes the "multipleOf" attribute in the numeric type definition

Parameters:

value - the value of the attribute

Returns:

the current NumericTypeBuilder instance