Class CustomizableDisplayText

java.lang.Object

net.okapia.osid.primordium.locale.CustomizableDisplayText

All Implemented Interfaces:

Serializable, Comparable<DisplayText>, DisplayText, OsidPrimitive, DisplayText, OsidPrimitive

public class CustomizableDisplayText
extends Object
implements DisplayText

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final int	compareTo(DisplayText arg0)
static CustomizableDisplayText	displayText(DisplayText displayText)	Wraps a displayText, rendering with its own string form.
static CustomizableDisplayText	displayText(DisplayText displayText, CustomizableDisplayText.Codec codec)	Wraps a displayText, rendering with the given codec.
final boolean	equals(Object arg0)
protected DisplayText	getDelegate()	Gets the wrapped displayText.
final Type	getFormatType()
final Type	getLanguageType()
final Type	getScriptType()
final String	getText()
final int	hashCode()
String	toString()	Returns the string form of this displayText.

Methods inherited from class Object

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

Constructor Details

CustomizableDisplayText

protected CustomizableDisplayText(DisplayText delegate)

Constructs a new CustomizableDisplayText that renders with the wrapped displayText's own string form.

Parameters:

delegate - the displayText to wrap

Throws:

NullArgumentException - delegate is null

CustomizableDisplayText

protected CustomizableDisplayText(DisplayText delegate,
 CustomizableDisplayText.Codec codec)

Constructs a new CustomizableDisplayText that renders with the given codec.

Parameters:

delegate - the displayText to wrap

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

Throws:

NullArgumentException - delegate is null

Method Details

displayText

public static CustomizableDisplayText displayText(DisplayText displayText)

Wraps a displayText, rendering with its own string form.

Parameters:

displayText - the displayText to wrap

Returns:

the wrapped displayText

Throws:

NullArgumentException - displayText is null

displayText

public static CustomizableDisplayText displayText(DisplayText displayText,
 CustomizableDisplayText.Codec codec)

Wraps a displayText, rendering with the given codec.

Parameters:

displayText - the displayText to wrap

codec - the codec used by toString()

Returns:

the wrapped displayText

Throws:

NullArgumentException - displayText or codec is null

getDelegate

protected DisplayText getDelegate()

Gets the wrapped displayText.

Returns:

the wrapped displayText

getLanguageType

@OSID
public final Type getLanguageType()

Specified by:

getLanguageType in interface DisplayText

getScriptType

@OSID
public final Type getScriptType()

Specified by:

getScriptType in interface DisplayText

getFormatType

@OSID
public final Type getFormatType()

Specified by:

getFormatType in interface DisplayText

getText

@OSID
public final String getText()

Specified by:

getText in interface DisplayText

compareTo

@OSIDBinding
public final int compareTo(DisplayText arg0)

Specified by:

compareTo in interface Comparable<DisplayText>

Specified by:

compareTo in interface DisplayText

equals

@OSIDBinding
public final boolean equals(Object arg0)

Specified by:

equals in interface DisplayText

Overrides:

equals in class Object

hashCode

@OSIDBinding
public final int hashCode()

Specified by:

hashCode in interface DisplayText

Overrides:

hashCode in class Object

toString

@OSIDBinding
public String toString()

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