net.charlesames.utility.common
Class Specification

java.lang.Object
  net.charlesames.utility.common.Specification

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

TypeOfMidiControl

public abstract class Specification
extends java.lang.Object
implements java.io.Serializable

Base class for objects which require online documentation.

Author:

Charles Ames

See Also:

Serialized Form

Constructor Summary

Specification(java.lang.String name)
Constructor for Specification instances.

Method Summary

void	appendHtmlComment(java.lang.String comment) Appends additional text to the HTML comment.
java.lang.String	getHtmlComment()
java.lang.String	getName()
void	setHtmlComment(java.lang.String comment) Sets the initial HTML comment text.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Specification

public Specification(java.lang.String name)

Constructor for Specification instances.

Parameters:

name - The specification name.

Method Detail

getName

public java.lang.String getName()

Returns:

The specification name.

getHtmlComment

public java.lang.String getHtmlComment()

Returns:

An HTML-formatted comment describing the object.

setHtmlComment

public void setHtmlComment(java.lang.String comment)

Sets the initial HTML comment text. Call this function only once.

Parameters:

comment - An HTML-formatted comment describing the object.

appendHtmlComment

public void appendHtmlComment(java.lang.String comment)

Appends additional text to the HTML comment. Each call to this method will tack more text onto the end of the existing comment.

Parameters:

comment - More HTML-formatted text describing the object.

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object