org.mule.runtime.api.metadata

Class TypedValue<T>

java.lang.Object

org.mule.runtime.api.metadata.TypedValue<T>

Type Parameters:

T - the content type.

All Implemented Interfaces:

Serializable

public final class TypedValue<T>
extends Object
implements Serializable

Maintains a value that has an associated DataType.

Since:

1.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TypedValue(T value, DataType dataType) Constructs a new TypedValue with the given parameters.
TypedValue(T value, DataType dataType, Optional<Long> length) Deprecated. Use TypedValue(Object, DataType, OptionalLong) instead.
TypedValue(T value, DataType dataType, OptionalLong length) Constructs a new TypedValue with the given parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
OptionalLong	getByteLength() If available obtain the length (in bytes) of the valye.
DataType	getDataType() Returns the data type (if any) associated with this TypedValue's content.
Optional<Long>	getLength() Deprecated. Use getByteLength() instead.
T	getValue()
int	hashCode()
static <T> TypedValue<T>	of(T value) Creates a new instance for the given value, using an auto calculated DataType.
String	toString()
static <T> T	unwrap(Object value) Utility method to obtain a type value's content, in cases in which you don't know if the value is a type value at all.

Methods inherited from class java.lang.Object

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

Constructor Detail

TypedValue

public TypedValue(T value,
                  DataType dataType)

Constructs a new TypedValue with the given parameters.

Parameters:

value - this object's content.

dataType - the DataType for this object's content.

TypedValue

@Deprecated
public TypedValue(T value,
                              DataType dataType,
                              Optional<Long> length)

Deprecated. Use TypedValue(Object, DataType, OptionalLong) instead.

Constructs a new TypedValue with the given parameters.

Parameters:

value - this object's content.

dataType - the DataType for this object's content.

length - the length of the value in bytes.

TypedValue

public TypedValue(T value,
                  DataType dataType,
                  OptionalLong length)

Constructs a new TypedValue with the given parameters.

Parameters:

value - this object's content.

dataType - the DataType for this object's content.

length - the length of the value in bytes.

Method Detail

unwrap

public static <T> T unwrap(Object value)

Utility method to obtain a type value's content, in cases in which you don't know if the value is a type value at all.

If value is a TypeValue, then getValue() is returned. Otherwise, the value is returned as is (even if it's null)

Type Parameters:

T - the output's generic type

Parameters:

value - a value which may or may not be a TypeValue

Returns:

an unwrapped value

of

public static <T> TypedValue<T> of(T value)

Creates a new instance for the given value, using an auto calculated DataType. This method is useful when no particular media types or encoding are required

Type Parameters:

T - the value's generic type

Parameters:

value - this object's content

Returns:

a new TypedValue

getDataType

public DataType getDataType()

Returns the data type (if any) associated with this TypedValue's content.

Returns:

the DataType for this object's content.

getValue

public T getValue()

Returns:

this object's content.

getLength

@Deprecated
public Optional<Long> getLength()

Deprecated. Use getByteLength() instead.

If available obtain the length (in bytes) of the valye.

Returns:

length of the value in bytes.

getByteLength

public OptionalLong getByteLength()

If available obtain the length (in bytes) of the valye.

Returns:

length of the value in bytes.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object