Overview  Package   Class  Use  Deprecated  Index
Home >> All >> normal >> [ options overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

normal.options
Class NormalOptionSet  

java.lang.Object
  OptionSet
      normal.options.NormalOptionSet

---

public class NormalOptionSet

extends OptionSet

Provides an option set with a cache of frequently used options for faster access. These are accessed through direct variable lookup as opposed to the usual dictionary search with string comparisons.

These frequently used options should only be accessed through the appropriate getOptionName() and setOptionName() methods, and never through the standard methods getStringOption(), setBooleanOption(), etc.

Options that are not explicitly cached by NormalOptionSet should, however, still be accessed through the standard OptionSet access methods.

Cached options will always provide values. If they do not appear in the option set, they will be given default values upon construction of the option set.

---

Field Summary
private  boolean	autoDock           A particular cached option.
static boolean	defaultAutoDock           The default for a particular cached option.
static boolean	defaultDisplayIcon           The default for a particular cached option.
private  boolean	displayIcon           A particular cached option.
static java.lang.String	normalComment           The comment to place at the beginning of the option file.
static java.lang.String	optionAutoDock           Full option name for a particular cached option.
static java.lang.String	optionDisplayIcon           Full option name for a particular cached option.

 

Constructor Summary

NormalOptionSet(java.io.File optionFile)           Creates a new option set based on the given file.

NormalOptionSet(java.io.File optionFile, boolean forceLoad)           Creates a new option set based on the given file.

 

Method Summary
boolean	getAutoDock()           Get a particular cached option.
boolean	getDisplayIcon()           Get a particular cached option.
protected  void	readFromFile()           Attempt to read this option set from file.
void	setAutoDock(boolean value)           Set a particular cached option.
void	setDisplayIcon(boolean value)           Set a particular cached option.
void	writeToFile(boolean forceWrite)           Attempt to write this option set to file.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

normalComment

public static final java.lang.String normalComment

The comment to place at the beginning of the option file.

See Also:

Constant Field Values

---

optionAutoDock

public static final java.lang.String optionAutoDock

Full option name for a particular cached option.

See Also:

Constant Field Values

---

optionDisplayIcon

public static final java.lang.String optionDisplayIcon

Full option name for a particular cached option.

See Also:

Constant Field Values

---

defaultAutoDock

public static final boolean defaultAutoDock

The default for a particular cached option.

See Also:

Constant Field Values

---

defaultDisplayIcon

public static final boolean defaultDisplayIcon

The default for a particular cached option.

See Also:

Constant Field Values

---

autoDock

private boolean autoDock

A particular cached option.

---

displayIcon

private boolean displayIcon

A particular cached option.

Constructor Detail

NormalOptionSet

public NormalOptionSet(java.io.File optionFile)

Creates a new option set based on the given file. All options stored in the file will be loaded. Any errors that occur when reading from file will be ignored.

---

NormalOptionSet

public NormalOptionSet(java.io.File optionFile,
                       boolean forceLoad)
                throws java.io.IOException

Creates a new option set based on the given file. All options stored in the file will be loaded.

Method Detail

readFromFile

protected void readFromFile()
                     throws java.io.IOException

Attempt to read this option set from file.

---

writeToFile

public void writeToFile(boolean forceWrite)
                 throws java.io.IOException

Attempt to write this option set to file.

---

getAutoDock

public boolean getAutoDock()

Get a particular cached option.

---

setAutoDock

public void setAutoDock(boolean value)

Set a particular cached option.

---

getDisplayIcon

public boolean getDisplayIcon()

Get a particular cached option.

---

setDisplayIcon

public void setDisplayIcon(boolean value)

Set a particular cached option.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> normal >> [ options overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---