org.mule.runtime.core.internal.metadata

Class DefaultDataTypeBuilder

java.lang.Object

org.mule.runtime.core.internal.metadata.DefaultDataTypeBuilder

All Implemented Interfaces:

org.mule.runtime.api.metadata.DataTypeBuilder, org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeCollectionTypeBuilder, org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeFunctionTypeBuilder, org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeMapTypeBuilder, org.mule.runtime.api.metadata.DataTypeParamsBuilder

public class DefaultDataTypeBuilder
extends Object
implements org.mule.runtime.api.metadata.DataTypeBuilder, org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeCollectionTypeBuilder, org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeFunctionTypeBuilder, org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeMapTypeBuilder

Provides a way to build immutable DataType objects.

Since:

4.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.mule.runtime.api.metadata.DataTypeBuilder

org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeCollectionTypeBuilder, org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeFunctionTypeBuilder, org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeMapTypeBuilder

Constructor Summary

Constructors

Constructor and Description
DefaultDataTypeBuilder()
DefaultDataTypeBuilder(org.mule.runtime.api.metadata.DataType dataType)

Method Summary

Modifier and Type	Method and Description
org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeCollectionTypeBuilder	asCollectionTypeBuilder()
org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeFunctionTypeBuilder	asFunctionTypeBuilder()
org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeMapTypeBuilder	asMapTypeBuilder()
org.mule.runtime.api.metadata.DataType	build() Builds a new DataType with the values set in this builder.
org.mule.runtime.api.metadata.DataTypeBuilder	charset(Charset charset)
org.mule.runtime.api.metadata.DataTypeBuilder	charset(String charset) Sets the given charset.
org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeCollectionTypeBuilder	collectionType(Class<? extends Collection> collectionType) Sets the given type for the DefaultCollectionDataType to be built.
protected org.mule.runtime.api.metadata.DataType	doBuild()
boolean	equals(Object obj)
org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeFunctionTypeBuilder	fromFunction(org.mule.runtime.api.el.ExpressionFunction expressionFunction)
org.mule.runtime.api.metadata.DataTypeParamsBuilder	fromObject(Object value)
org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeFunctionTypeBuilder	functionType(Class<? extends org.mule.runtime.api.el.ExpressionFunction> functionType)
protected Class<?>	handleProxy(Class<?> type)
int	hashCode()
static boolean	isConsumable(Class<?> payloadClass) Determines if the payload of this message is consumable i.e.
protected static <T> boolean	isProxyClass(Class<T> type) Cache which classes are proxies.
org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeCollectionTypeBuilder	itemMediaType(org.mule.runtime.api.metadata.MediaType itemMediaType)
org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeCollectionTypeBuilder	itemMediaType(String itemMimeType)
org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeCollectionTypeBuilder	itemType(Class<?> itemType) Sets the given types for the DefaultCollectionDataType to be built.
org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeMapTypeBuilder	keyMediaType(org.mule.runtime.api.metadata.MediaType keyMediaType)
org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeMapTypeBuilder	keyMediaType(String keyMediaType)
org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeMapTypeBuilder	keyType(Class<?> keyType)
org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeMapTypeBuilder	mapType(Class<? extends Map> mapType)
org.mule.runtime.api.metadata.DataTypeBuilder	mediaType(org.mule.runtime.api.metadata.MediaType mediaType)
org.mule.runtime.api.metadata.DataTypeBuilder	mediaType(String mediaType) Sets the given mediaType string.
org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeFunctionTypeBuilder	parametersType(List<org.mule.runtime.api.metadata.FunctionParameter> list)
org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeFunctionTypeBuilder	returnType(org.mule.runtime.api.metadata.DataType dataType)
org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeCollectionTypeBuilder	streamType(Class<? extends Iterator> iteratorType)
protected void	throwAlreadyBuilt()
org.mule.runtime.api.metadata.DataTypeParamsBuilder	type(Class<?> type) Sets the given typeRef for the DataType to be built.
protected void	validateAlreadyBuilt()
org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeMapTypeBuilder	valueMediaType(org.mule.runtime.api.metadata.MediaType valueMediaType)
org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeMapTypeBuilder	valueMediaType(String valueMediaType)
org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeMapTypeBuilder	valueType(Class<?> valueType)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultDataTypeBuilder

public DefaultDataTypeBuilder()

DefaultDataTypeBuilder

public DefaultDataTypeBuilder(org.mule.runtime.api.metadata.DataType dataType)

Method Detail

type

public org.mule.runtime.api.metadata.DataTypeParamsBuilder type(Class<?> type)

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

Specified by:

type in interface org.mule.runtime.api.metadata.DataTypeBuilder

Parameters:

type - the java typeRef to set.

Returns:

this builder.

handleProxy

protected Class<?> handleProxy(Class<?> type)

isProxyClass

protected static <T> boolean isProxyClass(Class<T> type)

Cache which classes are proxies. Very experimental

streamType

public org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeCollectionTypeBuilder streamType(Class<? extends Iterator> iteratorType)

Specified by:

streamType in interface org.mule.runtime.api.metadata.DataTypeBuilder

collectionType

public org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeCollectionTypeBuilder collectionType(Class<? extends Collection> collectionType)

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

Specified by:

collectionType in interface org.mule.runtime.api.metadata.DataTypeBuilder

Parameters:

collectionType - the java collection type to set.

Returns:

this builder.

Throws:

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

asCollectionTypeBuilder

public org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeCollectionTypeBuilder asCollectionTypeBuilder()

Specified by:

asCollectionTypeBuilder in interface org.mule.runtime.api.metadata.DataTypeBuilder

functionType

public org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeFunctionTypeBuilder functionType(Class<? extends org.mule.runtime.api.el.ExpressionFunction> functionType)

Specified by:

functionType in interface org.mule.runtime.api.metadata.DataTypeBuilder

asFunctionTypeBuilder

public org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeFunctionTypeBuilder asFunctionTypeBuilder()

Specified by:

asFunctionTypeBuilder in interface org.mule.runtime.api.metadata.DataTypeBuilder

mapType

public org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeMapTypeBuilder mapType(Class<? extends Map> mapType)

Specified by:

mapType in interface org.mule.runtime.api.metadata.DataTypeBuilder

asMapTypeBuilder

public org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeMapTypeBuilder asMapTypeBuilder()

Specified by:

asMapTypeBuilder in interface org.mule.runtime.api.metadata.DataTypeBuilder

itemType

public org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeCollectionTypeBuilder itemType(Class<?> itemType)

Sets the given types for the DefaultCollectionDataType to be built. See SimpleDataType.getType() and DefaultCollectionDataType.getItemDataType().

Specified by:

itemType in interface org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeCollectionTypeBuilder

Parameters:

itemType - the java type to set.

Returns:

this builder.

Throws:

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

returnType

public org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeFunctionTypeBuilder returnType(org.mule.runtime.api.metadata.DataType dataType)

Specified by:

returnType in interface org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeFunctionTypeBuilder

parametersType

public org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeFunctionTypeBuilder parametersType(List<org.mule.runtime.api.metadata.FunctionParameter> list)

Specified by:

parametersType in interface org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeFunctionTypeBuilder

keyType

public org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeMapTypeBuilder keyType(Class<?> keyType)

Specified by:

keyType in interface org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeMapTypeBuilder

valueType

public org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeMapTypeBuilder valueType(Class<?> valueType)

Specified by:

valueType in interface org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeMapTypeBuilder

mediaType

public org.mule.runtime.api.metadata.DataTypeBuilder mediaType(String mediaType)

Sets the given mediaType string. See DataType.getMediaType().

If the media type for the given string has a charset parameter, that will be set as the charset for the DataType being built. That charset can be overridden by calling charset(String).

Specified by:

mediaType in interface org.mule.runtime.api.metadata.DataTypeParamsBuilder

Parameters:

mediaType - the media type string to set

Returns:

this builder.

Throws:

IllegalArgumentException - if the given media type string is invalid.

mediaType

public org.mule.runtime.api.metadata.DataTypeBuilder mediaType(org.mule.runtime.api.metadata.MediaType mediaType)

Specified by:

mediaType in interface org.mule.runtime.api.metadata.DataTypeParamsBuilder

itemMediaType

public org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeCollectionTypeBuilder itemMediaType(String itemMimeType)

Specified by:

itemMediaType in interface org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeCollectionTypeBuilder

itemMediaType

public org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeCollectionTypeBuilder itemMediaType(org.mule.runtime.api.metadata.MediaType itemMediaType)

Specified by:

itemMediaType in interface org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeCollectionTypeBuilder

keyMediaType

public org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeMapTypeBuilder keyMediaType(String keyMediaType)

Specified by:

keyMediaType in interface org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeMapTypeBuilder

keyMediaType

public org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeMapTypeBuilder keyMediaType(org.mule.runtime.api.metadata.MediaType keyMediaType)

Specified by:

keyMediaType in interface org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeMapTypeBuilder

valueMediaType

public org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeMapTypeBuilder valueMediaType(String valueMediaType)

Specified by:

valueMediaType in interface org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeMapTypeBuilder

valueMediaType

public org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeMapTypeBuilder valueMediaType(org.mule.runtime.api.metadata.MediaType valueMediaType)

Specified by:

valueMediaType in interface org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeMapTypeBuilder

charset

public org.mule.runtime.api.metadata.DataTypeBuilder charset(String charset)

Sets the given charset. See MediaType.getCharset().

Specified by:

charset in interface org.mule.runtime.api.metadata.DataTypeParamsBuilder

Parameters:

charset - the encoding to set.

Returns:

this builder.

charset

public org.mule.runtime.api.metadata.DataTypeBuilder charset(Charset charset)

Specified by:

charset in interface org.mule.runtime.api.metadata.DataTypeParamsBuilder

fromObject

public org.mule.runtime.api.metadata.DataTypeParamsBuilder fromObject(Object value)

Specified by:

fromObject in interface org.mule.runtime.api.metadata.DataTypeBuilder

fromFunction

public org.mule.runtime.api.metadata.DataTypeBuilder.DataTypeFunctionTypeBuilder fromFunction(org.mule.runtime.api.el.ExpressionFunction expressionFunction)

Specified by:

fromFunction in interface org.mule.runtime.api.metadata.DataTypeBuilder

build

public org.mule.runtime.api.metadata.DataType build()

Builds a new DataType with the values set in this builder.

Specified by:

build in interface org.mule.runtime.api.metadata.DataTypeParamsBuilder

Returns:

a newly built DataType.

doBuild

protected org.mule.runtime.api.metadata.DataType doBuild()

validateAlreadyBuilt

protected void validateAlreadyBuilt()

throwAlreadyBuilt

protected void throwAlreadyBuilt()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

isConsumable

public static boolean isConsumable(Class<?> payloadClass)

Determines if the payload of this message is consumable i.e. it can't be read more than once.