org.formulacompiler.compiler
Interface Describable

All Known Subinterfaces:

CallFrame, Spreadsheet, Spreadsheet.Cell, Spreadsheet.Range, Spreadsheet.Row, Spreadsheet.Sheet

public interface Describable

Interface implemented by all self-describing classes in AFC. These descriptions are meant for human consumption and should not be stored or reprocessed. They may change without announcement.

This interface is an API only. Do not implement it yourself.

Author:

peo

describe

java.lang.String describe()

Describes this object in a string meant for human consumption.

This method is separate from toString() so implementing classes can choose to have more defined (and possibly concise) versions of toString() while still returning more complete information for this method.

Returns:

The description, possibly with multiple lines of text. Meant for human consumption. Should not be stored or reprocessed. May change without announcement.

See Also:

toString()

toString

java.lang.String toString()

Describes this object in a string meant for human consumption.

Overrides:

toString in class java.lang.Object

Returns:

The description, possibly with multiple lines of text. Meant for human consumption. Should not be stored or reprocessed. May change without announcement.

See Also:

describe()