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.

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 Collections.
DataTypeBuilder.DataTypeCollectionTypeBuilder	collectionType(Class<? extends Collection> collectionType) Sets the given type for the CollectionDataType to be built.
DataTypeParamsBuilder	fromObject(Object value) Populates the builder from the given value.
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.

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 Collections.

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.