com.ds.fw.types
Interface FwDisplayableIF

All Known Subinterfaces:

FwAssociationIF, FwBooleanIF, FwDateIF, FwDateIntervalIF, FwIntegerIF, FwListIF, FwMoneyIF, FwSimpleObjectIF, FwTimeIF, FwTimestampIF, FwUniqueObjectIF

All Known Implementing Classes:

FwAssociation, FwBoolean, FwDate, FwDateInterval, FwDisplayable, FwInteger, FwList, FwMoney, FwSimpleObject, FwTime, FwTimestamp, FwUniqueObject

public interface FwDisplayableIF

The methods defined by this interface are intended for debugging purposes only. In general, subclasses should only override toStringValue().

Method Summary

java.lang.String	getClassName() This convenience method return the short class name.
java.lang.String	getDisplayString() If toStringValue is non-null then return it.
java.lang.String	getDisplayStringFor(java.lang.Object e) If the parameter implements FwDisplayableIF then return e.getDisplayString().
java.lang.String	toString() toString is understood by all objects but is included in this interface for conceptual completeness and documentation.
java.lang.String	toStringValue() Get the string form of the object's value.

Method Detail

toString

public java.lang.String toString()

toString is understood by all objects but is included in this interface for conceptual completeness and documentation. In general toString should always identify the instance type (class) and, if available, some value that differentiates this instance from other instances of the same type. The recommended toString format for classes that implement this interface is: "classname[value]".

Overrides:

toString in class java.lang.Object

toStringValue

public java.lang.String toStringValue()

Get the string form of the object's value. This string should not include the class name. The string should be one line and relatively short. Null is returned if there is not meaningful value for this instance. If the value is non-null it should be included in the toString result.

getDisplayString

public java.lang.String getDisplayString()

If toStringValue is non-null then return it. Otherwise return the class name.

getClassName

public java.lang.String getClassName()

This convenience method return the short class name. That is the class's name without the package prefix.

getDisplayStringFor

public java.lang.String getDisplayStringFor(java.lang.Object e)

If the parameter implements FwDisplayableIF then return e.getDisplayString(). Otherwise return e.toString().