Class CustomizableTime

java.lang.Object

net.okapia.osid.primordium.calendaring.time.CustomizableTime

All Implemented Interfaces:

Serializable, Comparable<Time>, OsidPrimitive, Time, Time, OsidPrimitive

public class CustomizableTime
extends Object
implements Time

A Time that wraps another time and forwards every method to it, so it carries exactly the wrapped value and the same identity: it is equal to the time it wraps and to any other time of the same value. The single seam is toString(); every other method is final, so a subclass cannot reach anything the contract depends on. Customize the string form by passing a CustomizableTime.Codec to time(org.osid.calendaring.Time, Codec), or by subclassing and overriding toString().

See CustomizableDistance for the full design rationale (value-based identity, the toString() seam, and the bundling pattern). Intentionally not final.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CustomizableTime.Codec	Formats a time to a string and parses it back.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CustomizableTime(Time delegate)	Constructs a new CustomizableTime that renders with the wrapped time's own string form.
protected	CustomizableTime(Time delegate, CustomizableTime.Codec codec)	Constructs a new CustomizableTime that renders with the given codec.

Method Summary

Modifier and Type	Method	Description
final int	compareTo(Time arg0)
final Time[]	denormalizeTime()
final boolean	equals(Object arg0)
final long	getAttoseconds()
protected Time	getDelegate()	Gets the wrapped time.
final long	getFemtoseconds()
final DateTimeResolution	getGranularity()
final long	getGranularityMultiplier()
final long	getHour()
final long	getMicroquectoseconds()
final long	getMicroseconds()
final long	getMilliquectoseconds()
final long	getMilliseconds()
final long	getMinute()
final long	getNanoseconds()
final long	getPicoseconds()
final long	getPlanckseconds()
final long	getQuectoseconds()
final long	getRontoseconds()
final long	getSecond()
final Type	getTimeType()
final long	getYoctoseconds()
final long	getZeptoseconds()
final int	hashCode()
final boolean	isExclusive(Time arg0)
final boolean	isGreater(Time arg0)
final boolean	isInclusive(Time arg0)
final boolean	isLess(Time arg0)
static CustomizableTime	time(Time time)	Wraps a time, rendering with its own string form.
static CustomizableTime	time(Time time, CustomizableTime.Codec codec)	Wraps a time, rendering with the given codec.
String	toString()	Returns the string form of this time.

Methods inherited from class Object

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

Constructor Details

CustomizableTime

protected CustomizableTime(Time delegate)

Constructs a new CustomizableTime that renders with the wrapped time's own string form.

Parameters:

delegate - the time to wrap

Throws:

NullArgumentException - delegate is null

CustomizableTime

protected CustomizableTime(Time delegate,
 CustomizableTime.Codec codec)

Constructs a new CustomizableTime that renders with the given codec.

Parameters:

delegate - the time to wrap

codec - the codec used by toString(), or null to render with the wrapped time's own string form

Throws:

NullArgumentException - delegate is null

Method Details

time

public static CustomizableTime time(Time time)

Wraps a time, rendering with its own string form.

Parameters:

time - the time to wrap

Returns:

the wrapped time

Throws:

NullArgumentException - time is null

time

public static CustomizableTime time(Time time,
 CustomizableTime.Codec codec)

Wraps a time, rendering with the given codec.

Parameters:

time - the time to wrap

codec - the codec used by toString()

Returns:

the wrapped time

Throws:

NullArgumentException - time or codec is null

getDelegate

protected Time getDelegate()

Gets the wrapped time.

Returns:

the wrapped time

getTimeType

@OSID
public final Type getTimeType()

Specified by:

getTimeType in interface Time

getHour

@OSID
public final long getHour()

Specified by:

getHour in interface Time

getMinute

@OSID
public final long getMinute()

Specified by:

getMinute in interface Time

getSecond

@OSID
public final long getSecond()

Specified by:

getSecond in interface Time

getMilliseconds

@OSID
public final long getMilliseconds()

Specified by:

getMilliseconds in interface Time

getMicroseconds

@OSID
public final long getMicroseconds()

Specified by:

getMicroseconds in interface Time

getNanoseconds

@OSID
public final long getNanoseconds()

Specified by:

getNanoseconds in interface Time

getPicoseconds

@OSID
public final long getPicoseconds()

Specified by:

getPicoseconds in interface Time

getFemtoseconds

@OSID
public final long getFemtoseconds()

Specified by:

getFemtoseconds in interface Time

getAttoseconds

@OSID
public final long getAttoseconds()

Specified by:

getAttoseconds in interface Time

getZeptoseconds

@OSID
public final long getZeptoseconds()

Specified by:

getZeptoseconds in interface Time

getYoctoseconds

@OSID
public final long getYoctoseconds()

Specified by:

getYoctoseconds in interface Time

getRontoseconds

@OSID
public final long getRontoseconds()

Specified by:

getRontoseconds in interface Time

getQuectoseconds

@OSID
public final long getQuectoseconds()

Specified by:

getQuectoseconds in interface Time

getMilliquectoseconds

@OSID
public final long getMilliquectoseconds()

Specified by:

getMilliquectoseconds in interface Time

getMicroquectoseconds

@OSID
public final long getMicroquectoseconds()

Specified by:

getMicroquectoseconds in interface Time

getPlanckseconds

@OSID
public final long getPlanckseconds()

Specified by:

getPlanckseconds in interface Time

getGranularity

@OSID
public final DateTimeResolution getGranularity()

Specified by:

getGranularity in interface Time

getGranularityMultiplier

@OSID
public final long getGranularityMultiplier()

Specified by:

getGranularityMultiplier in interface Time

isGreater

@OSIDBinding
public final boolean isGreater(Time arg0)

Specified by:

isGreater in interface Time

isLess

@OSIDBinding
public final boolean isLess(Time arg0)

Specified by:

isLess in interface Time

isInclusive

@OSIDBinding
public final boolean isInclusive(Time arg0)

Specified by:

isInclusive in interface Time

isExclusive

@OSIDBinding
public final boolean isExclusive(Time arg0)

Specified by:

isExclusive in interface Time

denormalizeTime

@OSIDBinding
public final Time[] denormalizeTime()

Specified by:

denormalizeTime in interface Time

compareTo

@OSIDBinding
public final int compareTo(Time arg0)

Specified by:

compareTo in interface Comparable<Time>

Specified by:

compareTo in interface Time

equals

@OSIDBinding
public final boolean equals(Object arg0)

Specified by:

equals in interface Time

Overrides:

equals in class Object

hashCode

@OSIDBinding
public final int hashCode()

Specified by:

hashCode in interface Time

Overrides:

hashCode in class Object

toString

@OSIDBinding
public String toString()

Returns the string form of this time. With a codec, this is codec.format(wrapped); otherwise it is the wrapped time's own string form. This is the one method a subclass may override.

Specified by:

toString in interface OsidPrimitive

Overrides:

toString in class Object

Returns:

the string form