Class CustomizableCoordinate

java.lang.Object

net.okapia.osid.primordium.mapping.CustomizableCoordinate

All Implemented Interfaces:

Serializable, Comparable<Coordinate>, Coordinate, OsidPrimitive, Coordinate, OsidPrimitive

public class CustomizableCoordinate
extends Object
implements Coordinate

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final int	compareTo(Coordinate arg0)
static CustomizableCoordinate	coordinate(Coordinate coordinate)	Wraps a coordinate, rendering with its own string form.
static CustomizableCoordinate	coordinate(Coordinate coordinate, CustomizableCoordinate.Codec codec)	Wraps a coordinate, rendering with the given codec.
final boolean	equals(Object arg0)
final Type	getCoordinateType()
protected Coordinate	getDelegate()	Gets the wrapped coordinate.
final long	getDimensions()
final BigDecimal[]	getValues()
final int	hashCode()
final boolean	isCloser(Coordinate arg0, Coordinate arg1)
final boolean	isExclusive(Coordinate arg0)
final boolean	isFarther(Coordinate arg0, Coordinate arg1)
final boolean	isInclusive(Coordinate arg0)
final boolean	isLarger(Coordinate arg0)
final boolean	isSmaller(Coordinate arg0)
String	toString()	Returns the string form of this coordinate.
static CustomizableCoordinate	valueOf(Coordinate coordinate)	Wraps a coordinate, rendering with its own string form.
static CustomizableCoordinate	valueOf(Coordinate coordinate, CustomizableCoordinate.Codec codec)	Wraps a coordinate, rendering with the given codec.

Methods inherited from class Object

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

Constructor Details

CustomizableCoordinate

protected CustomizableCoordinate(Coordinate delegate)

Constructs a new CustomizableCoordinate that renders with the wrapped coordinate's own string form.

Parameters:

delegate - the coordinate to wrap

Throws:

NullArgumentException - delegate is null

CustomizableCoordinate

protected CustomizableCoordinate(Coordinate delegate,
 CustomizableCoordinate.Codec codec)

Constructs a new CustomizableCoordinate that renders with the given codec.

Parameters:

delegate - the coordinate to wrap

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

Throws:

NullArgumentException - delegate is null

Method Details

valueOf

public static CustomizableCoordinate valueOf(Coordinate coordinate)

Wraps a coordinate, rendering with its own string form.

Parameters:

coordinate - the coordinate to wrap

Returns:

the wrapped coordinate

Throws:

NullArgumentException - coordinate is null

See Also:

• coordinate(org.osid.mapping.Coordinate)

coordinate

public static CustomizableCoordinate coordinate(Coordinate coordinate)

Wraps a coordinate, rendering with its own string form.

Parameters:

coordinate - the coordinate to wrap

Returns:

the wrapped coordinate

Throws:

NullArgumentException - coordinate is null

See Also:

• valueOf(org.osid.mapping.Coordinate)

valueOf

public static CustomizableCoordinate valueOf(Coordinate coordinate,
 CustomizableCoordinate.Codec codec)

Wraps a coordinate, rendering with the given codec.

Parameters:

coordinate - the coordinate to wrap

codec - the codec used by toString()

Returns:

the wrapped coordinate

Throws:

NullArgumentException - coordinate or codec is null

See Also:

• coordinate(org.osid.mapping.Coordinate, Codec)

coordinate

public static CustomizableCoordinate coordinate(Coordinate coordinate,
 CustomizableCoordinate.Codec codec)

Wraps a coordinate, rendering with the given codec.

Parameters:

coordinate - the coordinate to wrap

codec - the codec used by toString()

Returns:

the wrapped coordinate

Throws:

NullArgumentException - coordinate or codec is null

See Also:

• valueOf(org.osid.mapping.Coordinate, Codec)

getDelegate

protected Coordinate getDelegate()

Gets the wrapped coordinate.

Returns:

the wrapped coordinate

getCoordinateType

@OSID
public final Type getCoordinateType()

Specified by:

getCoordinateType in interface Coordinate

getDimensions

@OSID
public final long getDimensions()

Specified by:

getDimensions in interface Coordinate

getValues

@OSID
public final BigDecimal[] getValues()

Specified by:

getValues in interface Coordinate

isLarger

@OSIDBinding
public final boolean isLarger(Coordinate arg0)

Specified by:

isLarger in interface Coordinate

isSmaller

@OSIDBinding
public final boolean isSmaller(Coordinate arg0)

Specified by:

isSmaller in interface Coordinate

isCloser

@OSIDBinding
public final boolean isCloser(Coordinate arg0,
 Coordinate arg1)

Specified by:

isCloser in interface Coordinate

isFarther

@OSIDBinding
public final boolean isFarther(Coordinate arg0,
 Coordinate arg1)

Specified by:

isFarther in interface Coordinate

isInclusive

@OSIDBinding
public final boolean isInclusive(Coordinate arg0)

Specified by:

isInclusive in interface Coordinate

isExclusive

@OSIDBinding
public final boolean isExclusive(Coordinate arg0)

Specified by:

isExclusive in interface Coordinate

compareTo

@OSIDBinding
public final int compareTo(Coordinate arg0)

Specified by:

compareTo in interface Comparable<Coordinate>

Specified by:

compareTo in interface Coordinate

equals

@OSIDBinding
public final boolean equals(Object arg0)

Specified by:

equals in interface Coordinate

Overrides:

equals in class Object

hashCode

@OSIDBinding
public final int hashCode()

Specified by:

hashCode in interface Coordinate

Overrides:

hashCode in class Object

toString

@OSIDBinding
public String toString()

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