standup.profiling
Class Options

java.lang.Object
  standup.profiling.Options

All Implemented Interfaces:

XMLizable

Direct Known Subclasses:

OptionsCloudFrontend, OptionsJokeGeneration, OptionsLexicon

public abstract class Options
extends Object
implements XMLizable

A subclass of Options stores various option settings chosen by a user.

Note that Options implements XMLizable -- this is because a Options can be loaded/saved to disk as part of an XML file.

Author:

Ruli Manurung

Field Summary

private boolean

modified

Constructor Summary

Options()

Method Summary

abstract String	getDiffString(Options options) Returns a String that reports the difference between this instance and the given Options.
abstract OptionsGUI	getGUI(Dimension size) Returns an instance of an appropriate OptionsGUI.
abstract String	getXMLTag() Returns the XML tag associated with this implementation of Options.
boolean	isModified() Returns true if this Options has been modified since it was last loaded/saved, false otherwise.
void	setModified(boolean modifiedStatus)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface standup.xml.XMLizable

writeXML

Field Detail

modified

private boolean modified

Constructor Detail

Options

public Options()

Method Detail

getGUI

public abstract OptionsGUI getGUI(Dimension size)

Returns an instance of an appropriate OptionsGUI. The given Dimension indicates the preferred size. If given null, it will attempt to calculate a suitable size.

Returns:

getXMLTag

public abstract String getXMLTag()

Returns the XML tag associated with this implementation of Options.

Returns:

isModified

public boolean isModified()

Returns true if this Options has been modified since it was last loaded/saved, false otherwise.

Returns:

true if this Options has been modified since it was last loaded/saved, false otherwise.

setModified

public void setModified(boolean modifiedStatus)

getDiffString

public abstract String getDiffString(Options options)

Returns a String that reports the difference between this instance and the given Options. Currently used by the Playback tool to report changes applied when the Control Panel is accessed, since actual keystrokes and mouse movement/clicks are not saved.

Parameters:

options - The Options to be compared against this instance.

Returns:

A String detailing the difference between the two instances.