Class CustomizableSpeed

java.lang.Object

net.okapia.osid.primordium.mapping.CustomizableSpeed

All Implemented Interfaces:

Serializable, Comparable<Speed>, OsidPrimitive, Speed, Speed, OsidPrimitive

public class CustomizableSpeed
extends Object
implements Speed

A Speed that wraps another speed and forwards every method to it, so it carries exactly the wrapped value and the same identity: it is equal to the speed it wraps and to any other speed 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 CustomizableSpeed.Codec to speed(org.osid.mapping.Speed, 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	CustomizableSpeed.Codec	Formats a speed to a string and parses it back.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final int	compareTo(Speed arg0)
final boolean	equals(Object arg0)
protected Speed	getDelegate()	Gets the wrapped speed.
final Distance	getDistance()
final Speed	getLowerBound()
final DateTimeResolution	getTimeUnit()
final Speed	getUpperBound()
final int	hashCode()
final boolean	isContained(Speed arg0, Speed arg1)
final boolean	isExclusive(Speed arg0)
final boolean	isExclusive(Speed arg0, Speed arg1)
final boolean	isGreater(Speed arg0)
final boolean	isInclusive(Speed arg0)
final boolean	isLess(Speed arg0)
static CustomizableSpeed	speed(Speed speed)	Wraps a speed, rendering with its own string form.
static CustomizableSpeed	speed(Speed speed, CustomizableSpeed.Codec codec)	Wraps a speed, rendering with the given codec.
String	toString()	Returns the string form of this speed.

Methods inherited from class Object

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

Constructor Details

CustomizableSpeed

protected CustomizableSpeed(Speed delegate)

Constructs a new CustomizableSpeed that renders with the wrapped speed's own string form.

Parameters:

delegate - the speed to wrap

Throws:

NullArgumentException - delegate is null

CustomizableSpeed

protected CustomizableSpeed(Speed delegate,
 CustomizableSpeed.Codec codec)

Constructs a new CustomizableSpeed that renders with the given codec.

Parameters:

delegate - the speed to wrap

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

Throws:

NullArgumentException - delegate is null

Method Details

speed

public static CustomizableSpeed speed(Speed speed)

Wraps a speed, rendering with its own string form.

Parameters:

speed - the speed to wrap

Returns:

the wrapped speed

Throws:

NullArgumentException - speed is null

speed

public static CustomizableSpeed speed(Speed speed,
 CustomizableSpeed.Codec codec)

Wraps a speed, rendering with the given codec.

Parameters:

speed - the speed to wrap

codec - the codec used by toString()

Returns:

the wrapped speed

Throws:

NullArgumentException - speed or codec is null

getDelegate

protected Speed getDelegate()

Gets the wrapped speed.

Returns:

the wrapped speed

getDistance

@OSID
public final Distance getDistance()

Specified by:

getDistance in interface Speed

getTimeUnit

@OSID
public final DateTimeResolution getTimeUnit()

Specified by:

getTimeUnit in interface Speed

isGreater

@OSIDBinding
public final boolean isGreater(Speed arg0)

Specified by:

isGreater in interface Speed

isLess

@OSIDBinding
public final boolean isLess(Speed arg0)

Specified by:

isLess in interface Speed

isInclusive

@OSIDBinding
public final boolean isInclusive(Speed arg0)

Specified by:

isInclusive in interface Speed

isContained

@OSIDBinding
public final boolean isContained(Speed arg0,
 Speed arg1)

Specified by:

isContained in interface Speed

isExclusive

@OSIDBinding
public final boolean isExclusive(Speed arg0)

Specified by:

isExclusive in interface Speed

isExclusive

@OSIDBinding
public final boolean isExclusive(Speed arg0,
 Speed arg1)

Specified by:

isExclusive in interface Speed

getLowerBound

@OSIDBinding
public final Speed getLowerBound()

Specified by:

getLowerBound in interface Speed

getUpperBound

@OSIDBinding
public final Speed getUpperBound()

Specified by:

getUpperBound in interface Speed

compareTo

@OSIDBinding
public final int compareTo(Speed arg0)

Specified by:

compareTo in interface Comparable<Speed>

Specified by:

compareTo in interface Speed

equals

@OSIDBinding
public final boolean equals(Object arg0)

Specified by:

equals in interface Speed

Overrides:

equals in class Object

hashCode

@OSIDBinding
public final int hashCode()

Specified by:

hashCode in interface Speed

Overrides:

hashCode in class Object

toString

@OSIDBinding
public String toString()

Returns the string form of this speed. With a codec, this is codec.format(wrapped); otherwise it is the wrapped speed'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