org.mule.runtime.api.metadata

Interface DataTypeParamsBuilder

All Known Subinterfaces:

DataTypeBuilder, DataTypeBuilder.DataTypeCollectionTypeBuilder, DataTypeBuilder.DataTypeFunctionTypeBuilder, DataTypeBuilder.DataTypeMapTypeBuilder

public interface DataTypeParamsBuilder

Provides a way to set the java-type independent attributes when building an immutable DataType objects.

Implementations need not be thread safe.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
DataType	build() Builds a new DataType with the values set in this builder.
DataTypeParamsBuilder	charset(Charset charset) Sets the given encoding.
DataTypeParamsBuilder	charset(String charset) Sets the given encoding.
DataTypeParamsBuilder	mediaType(MediaType mediaType) Sets the given mediaType.
DataTypeParamsBuilder	mediaType(String mediaType) Sets the given mediaType string.

Method Detail

mediaType

DataTypeParamsBuilder 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 encoding for the DataType being built, unless it had been previously set.

An encoding set by a call to this method can be overridden by calling charset(String).

Parameters:

mediaType - the MIME type string to set. If null or empty, the builder is not changed.

Returns:

this builder.

Throws:

IllegalArgumentException - if the given media type string is invalid.

mediaType

DataTypeParamsBuilder mediaType(MediaType mediaType)

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

If the media type for the given string has a charset parameter, that will be set as the encoding for the DataType being built, unless it had been previously set.

An encoding set by a call to this method can be overridden by calling charset(String).

Parameters:

mediaType - the media type to set. If null, the builder is not changed.

Returns:

this builder.

charset

DataTypeParamsBuilder charset(String charset)

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

Parameters:

charset - the encoding to set. If null or empty, the builder is not changed.

Returns:

this builder.

Throws:

IllegalCharsetNameException - if the charset is invalid.

charset

DataTypeParamsBuilder charset(Charset charset)

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

Parameters:

charset - the encoding to set. If null or empty, the builder is not changed.

Returns:

this builder.

build

DataType build()

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

Returns:

a newly built DataType.