net.sf.mmm.util.lang.base.datatype.descriptor

Class AbstractDatatypeSegmentDescriptor<T,V>

java.lang.Object

net.sf.mmm.util.lang.base.datatype.descriptor.AbstractDatatypeSegmentDescriptor<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 Implemented Interfaces:

DatatypeSegmentDescriptor<T,V>

Direct Known Subclasses:

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

public abstract class AbstractDatatypeSegmentDescriptor<T,V>
extends Object
implements DatatypeSegmentDescriptor<T,V>

This is the implementation of DatatypeSegmentDescriptor.

Since:

6.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private String	name
private boolean	optional
private Class<V>	type

Fields inherited from interface net.sf.mmm.util.lang.api.DatatypeSegmentDescriptor

DEFAULT_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractDatatypeSegmentDescriptor(String name, Class<V> type) The constructor.
AbstractDatatypeSegmentDescriptor(String name, Class<V> type, boolean optional) The constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract V	doGetSegment(T datatype) Called from getSegment(Object) after validation (null-check).
String	getName()
V	getSegment(T datatype) Gets the value of the segment described by this object.
Class<V>	getType()
boolean	isOptional()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

private final String name

See Also:

getName()

type

private final Class<V> type

See Also:

getType()

optional

private final boolean optional

See Also:

isOptional()

Constructor Detail

AbstractDatatypeSegmentDescriptor

public AbstractDatatypeSegmentDescriptor(String name,
                                         Class<V> type)

The constructor.

Parameters:

name - - see getName().

type - - see getType().

AbstractDatatypeSegmentDescriptor

public AbstractDatatypeSegmentDescriptor(String name,
                                         Class<V> type,
                                         boolean optional)

The constructor.

Parameters:

name - - see getName().

type - - see getType().

optional - - see isOptional().

Method Detail

getSegment

public V getSegment(T datatype)

Gets the value of the segment described by this object.

Specified by:

getSegment in interface DatatypeSegmentDescriptor<T,V>

Parameters:

datatype - is the Datatype to disassemble.

Returns:

the value of the segment described by this object.

doGetSegment

protected abstract V doGetSegment(T datatype)

Called from getSegment(Object) after validation (null-check).

Parameters:

datatype - is the datatype instance. May not be null.

Returns:

the segment value.

getName

public String getName()

Specified by:

getName in interface DatatypeSegmentDescriptor<T,V>

Returns:

the name of the segment. For SimpleDatatype typically just DatatypeSegmentDescriptor.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

public Class<V> getType()

Specified by:

getType in interface DatatypeSegmentDescriptor<T,V>

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

public boolean isOptional()

Specified by:

isOptional in interface DatatypeSegmentDescriptor<T,V>

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.

toString

public String toString()

Overrides:

toString in class Object