com.tensegrity.generic.util
Interface CanonicalDescribable

All Known Subinterfaces:

StyleItem

All Known Implementing Classes:

DefaultStyleItem

public interface CanonicalDescribable

This interface represents an alternative to the built-in equals mechanism in the standard Java API to compare objects. An Implementor of this interface is then responsible to create a canonical string which represents the current instance. This string will then be used to compare instances.

Version:

$Id: CanonicalDescribable.java,v 1.3 2004/03/23 16:32:28 GillesIachelini Exp $

Author:

GillesIachelini

Field Summary

static java.lang.String

DELIMITER A constant string to be used as delimiter between tokens of the descriptive string.

Method Summary

java.lang.String

getCanonicalDescription() Returns the canonical description of this instance.

Field Detail

DELIMITER

public static final java.lang.String DELIMITER

A constant string to be used as delimiter between tokens of the descriptive string.

See Also:

Constant Field Values

Method Detail

getCanonicalDescription

public java.lang.String getCanonicalDescription()

Returns the canonical description of this instance. This is a non-null and non-empty string.

Returns:

the canonical description.