org.mule.runtime.api.metadata

Interface DataType

All Superinterfaces:

Serializable

All Known Subinterfaces:

CollectionDataType, FunctionDataType, MapDataType

public interface DataType
extends Serializable

Defines a Java type and its association with additional information about the data, like MIME type and encoding.

The java type may be a Collection, in which case implementations should provide additional information about the item type.

This also provides constants for some commonly used DataTypes.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static DataType	ATOM_STRING
static DataType	BOOLEAN
static DataType	BYTE_ARRAY
static DataType	CURSOR_ITERATOR_PROVIDER
static DataType	CURSOR_STREAM_PROVIDER
static DataType	HTML_STRING
static DataType	INPUT_STREAM
static DataType	ITERATOR
static DataType	JSON_STRING
static DataType	MULE_MESSAGE
static CollectionDataType	MULE_MESSAGE_COLLECTION
static CollectionDataType	MULE_MESSAGE_LIST
static MapDataType	MULE_MESSAGE_MAP
static DataType	NUMBER
static DataType	OBJECT
static DataType	RSS_STRING
static DataType	STRING
static DataType	TEXT_STRING
static DataType	XML_STRING

Method Summary

Modifier and Type	Method and Description
static DataTypeBuilder	builder() Provides a builder to create DataType objects.
static DataTypeBuilder	builder(DataType dataType) Provides a builder to create DataType objects based on an existing DataType instance.
static DataType	fromFunction(ExpressionFunction function) Shortcut to create the DataType from an ExpressionFunction instance.
static DataType	fromObject(Object value) Shortcut to create the DataType from an Object instance.
static DataType	fromType(Class<?> type) Shortcut to create a DataType using just a Java type.
MediaType	getMediaType() The mime type of the the source object to transform.
Class<?>	getType() The object type of the source object to transform.
boolean	isCompatibleWith(DataType dataType) Used to determine if this data type is compatible with the data type passed in.
boolean	isStreamType() Used to determine if this DataType is a stream type.

Field Detail

TEXT_STRING

static final DataType TEXT_STRING

XML_STRING

static final DataType XML_STRING

JSON_STRING

static final DataType JSON_STRING

HTML_STRING

static final DataType HTML_STRING

ATOM_STRING

static final DataType ATOM_STRING

RSS_STRING

static final DataType RSS_STRING

STRING

static final DataType STRING

NUMBER

static final DataType NUMBER

BOOLEAN

static final DataType BOOLEAN

OBJECT

static final DataType OBJECT

BYTE_ARRAY

static final DataType BYTE_ARRAY

INPUT_STREAM

static final DataType INPUT_STREAM

ITERATOR

static final DataType ITERATOR

CURSOR_STREAM_PROVIDER

static final DataType CURSOR_STREAM_PROVIDER

CURSOR_ITERATOR_PROVIDER

static final DataType CURSOR_ITERATOR_PROVIDER

MULE_MESSAGE

static final DataType MULE_MESSAGE

MULE_MESSAGE_COLLECTION

static final CollectionDataType MULE_MESSAGE_COLLECTION

MULE_MESSAGE_LIST

static final CollectionDataType MULE_MESSAGE_LIST

MULE_MESSAGE_MAP

static final MapDataType MULE_MESSAGE_MAP

Method Detail

builder

static DataTypeBuilder builder()

Provides a builder to create DataType objects.

Returns:

a new DataTypeBuilder.

builder

static DataTypeBuilder builder(DataType dataType)

Provides a builder to create DataType objects based on an existing DataType instance.

Parameters:

dataType - existing DataType to use as a template to create a new DataTypeBuilder instance.

Returns:

a new DataTypeBuilder based on the template dataType provided.

fromType

static DataType fromType(Class<?> type)

Shortcut to create a DataType using just a Java type. Default values will be used for mimeType and encoding.

Parameters:

type - the Java type to create DataType for.

Returns:

a new DataTypeBuilder for the given type.

fromObject

static DataType fromObject(Object value)

Shortcut to create the DataType from an Object instance.

This behaves in the same way as fromType(Class) creating a DataType based on the value type with default values being used for mimeType and encoding if the Object type has no mimeType or encoding. The DataTypeBuilder used by default may introspect certain types that do contain type this meta-data such as DataHandler and DataSource and populate mimeType and encoding values based on this.

Parameters:

value - the object to determine the DataType of.

Returns:

a new DataType for the given value.

fromFunction

static DataType fromFunction(ExpressionFunction function)

Shortcut to create the DataType from an ExpressionFunction instance.

This behaves in the same way as fromObject(Object) but automatically populates the returnType and parameters based on the function.

Parameters:

function - the function to determine the DataType of.

Returns:

a new DataType for the given value.

getType

Class<?> getType()

The object type of the source object to transform.

Returns:

the class object of the source object. This must not be null

getMediaType

MediaType getMediaType()

The mime type of the the source object to transform.

Returns:

the mime type of the source object.

isCompatibleWith

boolean isCompatibleWith(DataType dataType)

Used to determine if this data type is compatible with the data type passed in. This checks to see if this mime types matches the one in the given dataType and whether the Java types are assignable.

This method is NOT symmetric. That is, a.isCompatibleWith(b) and b.isCompatibleWith(a) may yield different result.

Parameters:

dataType - the dataType object to compare with

Returns:

true if the mime types are the same and this type can be assigned to the dataType.type.

isStreamType

boolean isStreamType()

Used to determine if this DataType is a stream type. Stream types, for example those that have a java type InputStream or Iterable, cannot be serialized without prior transformation or consumed twice and often their size, depending on the specific type, is unknown until they have been fully consumed.

Returns:

true if the type is a stream type otherwise false