org.openksavi.sponge.type

Class DataType<T>

java.lang.Object

org.openksavi.sponge.type.DataType<T>

All Implemented Interfaces:

Cloneable, Descriptive, HasFeatures

Direct Known Subclasses:

AnyType, BinaryType, BooleanType, CollectionType, DateTimeType, DynamicType, IntegerType, NumberType, ObjectType, RecordType, StreamType, StringType, TypeType, VoidType

public class DataType<T>
extends Object
implements Descriptive, HasFeatures, Cloneable

A data type. Used for example in action arguments metadata.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FEATURE_FORMAT The feature name for the format.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DataType(DataTypeKind kind, String name)

Method Summary

Modifier and Type	Method and Description
DataType<T>	clone()
Object	getDefaultValue()
String	getDescription() Returns the description.
Map<String,Object>	getFeatures() Returns the features.
String	getFormat()
DataTypeKind	getKind()
String	getLabel() Returns the label.
String	getName() Returns the name name.
ProvidedMeta	getProvided()
String	getRegisteredType()
boolean	isAnnotated()
boolean	isNullable()
boolean	isOptional()
boolean	isReadOnly()
void	setAnnotated(boolean annotated)
void	setDefaultValue(Object defaultValue)
void	setDescription(String description) Sets the description.
void	setFeatures(Map<String,Object> features) Sets the features.
void	setFormat(String format)
void	setLabel(String label) Sets the label.
void	setName(String name) Sets the name.
void	setNullable(boolean nullable)
void	setOptional(boolean optional)
void	setProvided(ProvidedMeta provided)
void	setReadOnly(boolean readOnly)
void	setRegisteredType(String registeredType)
DataType<T>	withAnnotated()
DataType<T>	withAnnotated(boolean annotated)
DataType<T>	withDefaultValue(AnnotatedValue<T> value)
DataType<T>	withDefaultValue(T value)
DataType<T>	withDescription(String description)
DataType<T>	withFeature(String name, Object value)
DataType<T>	withFeatures(Map<String,Object> features)
DataType<T>	withFormat(String format)
DataType<T>	withLabel(String label)
DataType<T>	withName(String name)
DataType<T>	withNullable()
DataType<T>	withNullable(boolean nullable)
DataType<T>	withOptional()
DataType<T>	withProvided(ProvidedMeta provided)
DataType<T>	withReadOnly()
DataType<T>	withReadOnly(boolean readOnly)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FEATURE_FORMAT

public static final String FEATURE_FORMAT

The feature name for the format.

See Also:

Constant Field Values

Constructor Detail

DataType

protected DataType(DataTypeKind kind,
                   String name)

Method Detail

withName

public DataType<T> withName(String name)

withLabel

public DataType<T> withLabel(String label)

withDescription

public DataType<T> withDescription(String description)

withAnnotated

public DataType<T> withAnnotated(boolean annotated)

withAnnotated

public DataType<T> withAnnotated()

withFormat

public DataType<T> withFormat(String format)

withDefaultValue

public DataType<T> withDefaultValue(T value)

withDefaultValue

public DataType<T> withDefaultValue(AnnotatedValue<T> value)

withNullable

public DataType<T> withNullable(boolean nullable)

withNullable

public DataType<T> withNullable()

withReadOnly

public DataType<T> withReadOnly(boolean readOnly)

withReadOnly

public DataType<T> withReadOnly()

withFeatures

public DataType<T> withFeatures(Map<String,Object> features)

withFeature

public DataType<T> withFeature(String name,
                               Object value)

withOptional

public DataType<T> withOptional()

withProvided

public DataType<T> withProvided(ProvidedMeta provided)

getKind

public DataTypeKind getKind()

getRegisteredType

public String getRegisteredType()

setRegisteredType

public void setRegisteredType(String registeredType)

getName

public String getName()

Description copied from interface: Descriptive

Returns the name name.

Specified by:

getName in interface Descriptive

Returns:

the name.

setName

public void setName(String name)

Description copied from interface: Descriptive

Sets the name.

Specified by:

setName in interface Descriptive

Parameters:

name - the name.

getLabel

public String getLabel()

Description copied from interface: Descriptive

Returns the label.

Specified by:

getLabel in interface Descriptive

Returns:

the label.

setLabel

public void setLabel(String label)

Description copied from interface: Descriptive

Sets the label.

Specified by:

setLabel in interface Descriptive

Parameters:

label - the label.

getDescription

public String getDescription()

Description copied from interface: Descriptive

Returns the description.

Specified by:

getDescription in interface Descriptive

Returns:

the description.

setDescription

public void setDescription(String description)

Description copied from interface: Descriptive

Sets the description.

Specified by:

setDescription in interface Descriptive

Parameters:

description - the description.

isAnnotated

public boolean isAnnotated()

setAnnotated

public void setAnnotated(boolean annotated)

getFormat

public String getFormat()

setFormat

public void setFormat(String format)

getDefaultValue

public Object getDefaultValue()

setDefaultValue

public void setDefaultValue(Object defaultValue)

isNullable

public boolean isNullable()

setNullable

public void setNullable(boolean nullable)

isReadOnly

public boolean isReadOnly()

setReadOnly

public void setReadOnly(boolean readOnly)

getFeatures

public Map<String,Object> getFeatures()

Description copied from interface: HasFeatures

Returns the features. The default value is the empty map.

Specified by:

getFeatures in interface HasFeatures

Returns:

the features. Never returns null.

setFeatures

public void setFeatures(Map<String,Object> features)

Description copied from interface: HasFeatures

Sets the features. Must not be null.

Specified by:

setFeatures in interface HasFeatures

Parameters:

features - the features.

isOptional

public boolean isOptional()

setOptional

public void setOptional(boolean optional)

getProvided

public ProvidedMeta getProvided()

setProvided

public void setProvided(ProvidedMeta provided)

clone

public DataType<T> clone()

Overrides:

clone in class Object