net.sf.mmm.util.lang.api

Interface DatatypeSegmentDescriptor<T,V>

Type Parameters:

T - is the generic type of the Datatype owning this segment.

V - is the generic type of the segment value.

All Known Implementing Classes:

AbstractDatatypeSegmentDescriptor, DatatypeDescriptorDate.DaySegment, DatatypeDescriptorDate.HourSegment, DatatypeDescriptorDate.MinuteSegment, DatatypeDescriptorDate.MonthSegment, DatatypeDescriptorDate.SecondSegment, DatatypeDescriptorDate.YearSegment, DatatypeDescriptorLocalDate.DaySegment, DatatypeDescriptorLocalDate.MonthSegment, DatatypeDescriptorLocalDate.YearSegment, DatatypeSegmentDescriptorEnum, DatatypeSegmentDescriptorSimpleDatatype

public interface DatatypeSegmentDescriptor<T,V>

This is the interface for a descriptor of a segment.
E.g. the DatatypeSegmentDescriptor for LocalDate.getYear() behaves as described by the following table:

Method	Result
getName()	"year"
getType()	Integer.class
getSegment(x)	x.getYear()

Since:

6.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_NAME The default name for the single segment of atomic datatypes.

Method Summary

Modifier and Type	Method and Description
String	getName()
V	getSegment(T datatype) Gets the value of the segment described by this object.
Class<V>	getType()
boolean	isOptional()

Field Detail

DEFAULT_NAME

static final String DEFAULT_NAME

The default name for the single segment of atomic datatypes.

See Also:

Constant Field Values

Method Detail

getName

String getName()

Returns:

the name of the segment. For SimpleDatatype typically just DEFAULT_NAME but significant for composite datatypes where the name is used as field names when the datatype is serialized to XML, JSON, a Map or whatever.

getType

Class<V> getType()

Returns:

the type of the segment. Should typically be a standard Java datatype such as String, Double, Long, Integer, Boolean, BigDecimal, etc. but may also be another custom Datatype.

isOptional

boolean isOptional()

Returns:

true if this segment is optional and can be omitted, false otherwise. Serialization is suggested to omit optional segments if their value is null. Further, creation shall accept less arguments if any number of optional arguments are skipped what requires that segment descriptors are ordered such that optional segments are at the end of the list.

getSegment

V getSegment(T datatype)

Gets the value of the segment described by this object.

Parameters:

datatype - is the Datatype to disassemble.

Returns:

the value of the segment described by this object.