org.mule.runtime.api.metadata

Interface DataTypeBuilder

All Superinterfaces:

DataTypeParamsBuilder

public interface DataTypeBuilder
extends DataTypeParamsBuilder

Provides a way to build immutable DataType objects.

Implementations need not be thread safe.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DataTypeBuilder.DataTypeCollectionTypeBuilder Provides methods to set data associated to the items of a Collection, when the type is a Collection.
static interface	DataTypeBuilder.DataTypeFunctionTypeBuilder Provides methods to set data associated to the resources of an ExpressionFunction.
static interface	DataTypeBuilder.DataTypeMapTypeBuilder Provides methods to set data associated to the keys and values of a Map, when the type is a Map.

Method Summary

Modifier and Type	Method and Description
DataTypeBuilder.DataTypeCollectionTypeBuilder	asCollectionTypeBuilder() Down-casts the builder to DataTypeBuilder.DataTypeCollectionTypeBuilder, allowing the builder to be used in a fluent way without having to cast it when dealing with Iterables.
DataTypeBuilder.DataTypeFunctionTypeBuilder	asFunctionTypeBuilder() Down-casts the builder to DataTypeBuilder.DataTypeFunctionTypeBuilder, allowing the builder to be used in a fluent way without having to cast it when dealing with ExpressionFunctions.
DataTypeBuilder.DataTypeMapTypeBuilder	asMapTypeBuilder() Down-casts the builder to DataTypeBuilder.DataTypeMapTypeBuilder, allowing the builder to be used in a fluent way without having to cast it when dealing with Maps.
DataTypeBuilder.DataTypeCollectionTypeBuilder	collectionType(Class<? extends Collection> collectionType) Sets the given type for the CollectionDataType to be built.
DataTypeBuilder.DataTypeFunctionTypeBuilder	fromFunction(ExpressionFunction function) Populates the builder from the given ExpressionFunction.
DataTypeParamsBuilder	fromObject(Object value) Populates the builder from the given value.
DataTypeBuilder.DataTypeFunctionTypeBuilder	functionType(Class<? extends ExpressionFunction> functionType) Sets the given type for the FunctionDataType to be built.
DataTypeBuilder.DataTypeMapTypeBuilder	mapType(Class<? extends Map> mapType) Sets the given type for the MapDataType to be built.
DataTypeBuilder.DataTypeCollectionTypeBuilder	streamType(Class<? extends Iterator> iteratorType) Sets the given type for the CollectionDataType to be built.
DataTypeParamsBuilder	type(Class<?> type) Sets the given type for the DataType to be built.

Methods inherited from interface org.mule.runtime.api.metadata.DataTypeParamsBuilder

build, charset, charset, mediaType, mediaType

Method Detail

type

DataTypeParamsBuilder type(Class<?> type)

Sets the given type for the DataType to be built. See DataType.getType().

Parameters:

type - the java type to set.

Returns:

this builder.

streamType

DataTypeBuilder.DataTypeCollectionTypeBuilder streamType(Class<? extends Iterator> iteratorType)

Sets the given type for the CollectionDataType to be built. See DataType.getType().

Parameters:

iteratorType - the java collection type to set.

Returns:

this builder.

Throws:

IllegalArgumentException - if the given collectionType is not a descendant of Iterator.

collectionType

DataTypeBuilder.DataTypeCollectionTypeBuilder collectionType(Class<? extends Collection> collectionType)

Sets the given type for the CollectionDataType to be built. See DataType.getType().

Parameters:

collectionType - the java collection type to set.

Returns:

this builder.

Throws:

IllegalArgumentException - if the given collectionType is not a descendant of Collection.

asCollectionTypeBuilder

DataTypeBuilder.DataTypeCollectionTypeBuilder asCollectionTypeBuilder()

Down-casts the builder to DataTypeBuilder.DataTypeCollectionTypeBuilder, allowing the builder to be used in a fluent way without having to cast it when dealing with Iterables.

Returns:

this builder.

functionType

DataTypeBuilder.DataTypeFunctionTypeBuilder functionType(Class<? extends ExpressionFunction> functionType)

Sets the given type for the FunctionDataType to be built.

Parameters:

functionType - the java ExpressionFunction type to set

Returns:

this builder

asFunctionTypeBuilder

DataTypeBuilder.DataTypeFunctionTypeBuilder asFunctionTypeBuilder()

Down-casts the builder to DataTypeBuilder.DataTypeFunctionTypeBuilder, allowing the builder to be used in a fluent way without having to cast it when dealing with ExpressionFunctions.

Returns:

this builder.

mapType

DataTypeBuilder.DataTypeMapTypeBuilder mapType(Class<? extends Map> mapType)

Sets the given type for the MapDataType to be built.

Parameters:

mapType - the java map type to set

Returns:

this builder

asMapTypeBuilder

DataTypeBuilder.DataTypeMapTypeBuilder asMapTypeBuilder()

Down-casts the builder to DataTypeBuilder.DataTypeMapTypeBuilder, allowing the builder to be used in a fluent way without having to cast it when dealing with Maps.

Returns:

this builder.

fromObject

DataTypeParamsBuilder fromObject(Object value)

Populates the builder from the given value.

This method will get the type, mimeType and encoding from the given value according to its concrete type.

Parameters:

value - an object instance.

Returns:

this builder.

fromFunction

DataTypeBuilder.DataTypeFunctionTypeBuilder fromFunction(ExpressionFunction function)

Populates the builder from the given ExpressionFunction.

Parameters:

function - the ExpressionFunction to use

Returns:

this builder