Class CustomizableVersion

java.lang.Object

net.okapia.osid.primordium.installation.CustomizableVersion

All Implemented Interfaces:

Serializable, Comparable<Version>, OsidPrimitive, Version, Version, OsidPrimitive

public class CustomizableVersion
extends Object
implements Version

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final int	compareTo(Version arg0)
final boolean	equals(Object arg0)
final String[]	getComponents()
protected Version	getDelegate()	Gets the wrapped version.
final Type	getScheme()
final int	hashCode()
final boolean	isExclusive(Version arg0)
final boolean	isInclusive(Version arg0)
final boolean	isNewer(Version arg0)
final boolean	isOlder(Version arg0)
String	toString()	Returns the string form of this version.
static CustomizableVersion	version(Version version)	Wraps a version, rendering with its own string form.
static CustomizableVersion	version(Version version, CustomizableVersion.Codec codec)	Wraps a version, rendering with the given codec.

Methods inherited from class Object

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

Constructor Details

CustomizableVersion

protected CustomizableVersion(Version delegate)

Constructs a new CustomizableVersion that renders with the wrapped version's own string form.

Parameters:

delegate - the version to wrap

Throws:

NullArgumentException - delegate is null

CustomizableVersion

protected CustomizableVersion(Version delegate,
 CustomizableVersion.Codec codec)

Constructs a new CustomizableVersion that renders with the given codec.

Parameters:

delegate - the version to wrap

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

Throws:

NullArgumentException - delegate is null

Method Details

version

public static CustomizableVersion version(Version version)

Wraps a version, rendering with its own string form.

Parameters:

version - the version to wrap

Returns:

the wrapped version

Throws:

NullArgumentException - version is null

version

public static CustomizableVersion version(Version version,
 CustomizableVersion.Codec codec)

Wraps a version, rendering with the given codec.

Parameters:

version - the version to wrap

codec - the codec used by toString()

Returns:

the wrapped version

Throws:

NullArgumentException - version or codec is null

getDelegate

protected Version getDelegate()

Gets the wrapped version.

Returns:

the wrapped version

getScheme

@OSID
public final Type getScheme()

Specified by:

getScheme in interface Version

getComponents

@OSID
public final String[] getComponents()

Specified by:

getComponents in interface Version

isNewer

@OSIDBinding
public final boolean isNewer(Version arg0)

Specified by:

isNewer in interface Version

isOlder

@OSIDBinding
public final boolean isOlder(Version arg0)

Specified by:

isOlder in interface Version

isInclusive

@OSIDBinding
public final boolean isInclusive(Version arg0)

Specified by:

isInclusive in interface Version

isExclusive

@OSIDBinding
public final boolean isExclusive(Version arg0)

Specified by:

isExclusive in interface Version

compareTo

@OSIDBinding
public final int compareTo(Version arg0)

Specified by:

compareTo in interface Comparable<Version>

Specified by:

compareTo in interface Version

equals

@OSIDBinding
public final boolean equals(Object arg0)

Specified by:

equals in interface Version

Overrides:

equals in class Object

hashCode

@OSIDBinding
public final int hashCode()

Specified by:

hashCode in interface Version

Overrides:

hashCode in class Object

toString

@OSIDBinding
public String toString()

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