edu.rice.cs.drjava.config
Class FileOption

java.lang.Object
  |
  +--edu.rice.cs.drjava.config.OptionParser
        |
        +--edu.rice.cs.drjava.config.Option
              |
              +--edu.rice.cs.drjava.config.FileOption
All Implemented Interfaces:
FormatStrategy, ParseStrategy

public class FileOption
extends Option

Class representing all configuration options with values of type File.

Version:
$Id: FileOption.java,v 1.5 2002/07/08 02:47:14 csreis Exp $

Field Summary
static File NULL_FILE
          Special sentinal file indicating that this option is not set.
 
Fields inherited from class edu.rice.cs.drjava.config.Option
listeners
 
Fields inherited from class edu.rice.cs.drjava.config.OptionParser
defaultValue, map, name
 
Constructor Summary
FileOption(String key, File def)
           
 
Method Summary
 String format(File f)
           
 String format(Object x0)
          the ability to format a statically typed T value to a String.
 Object getDefault()
           
(package private)  Object getOption(DefaultOptionMap x0)
          the accessor for the magic-typed hashtable stunt.
(package private)  void notifyListeners(Configuration x0, Object x1)
           
 File parse(String s)
          the ability to parse a string to an object of type T.
 File parse(String s)
          the ability to parse a string to an object of type T.
(package private)  Object remove(DefaultOptionMap x0)
          the destructor for a mapping in the magic-typed hashtable.
(package private)  Object setOption(DefaultOptionMap x0, Object x1)
          the mutator for the magic-typed hashtable stunt.
(package private)  Object setString(DefaultOptionMap x0, String x1)
          uses parse() and setOption() so that any changes in parsing will automatically be applied to setString().
 
Methods inherited from class edu.rice.cs.drjava.config.Option
addListener, getDefaultString, getString, removeListener
 
Methods inherited from class edu.rice.cs.drjava.config.OptionParser
getName
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait
 

Field Detail

NULL_FILE

public static final File NULL_FILE
Special sentinal file indicating that this option is not set.
Constructor Detail

FileOption

public FileOption(String key,
                  File def)
Parameters:
key - The name of this option.
Method Detail

parse

public File parse(String s)
Description copied from class: OptionParser
the ability to parse a string to an object of type T. All concrete versions of this class must override this method to provide some sort of parser implementation.
Overrides:
parse in class OptionParser
Parameters:
s - The String to be parsed, must represent the absolute path of the File to be created.
Returns:
The File object corresponding to path "p".

format

public String format(File f)
Parameters:
f - The instance of class File to be formatted.
Returns:
A String representing the absolute path of "f".

notifyListeners

void notifyListeners(Configuration x0,
                     Object x1)
Overrides:
notifyListeners in class Option

format

public String format(Object x0)
Description copied from class: Option
the ability to format a statically typed T value to a String. Since T is an Object, the default implementation uses the .toString() method.
Overrides:
format in class Option
Following copied from class: edu.rice.cs.drjava.config.Option
Parameters:
value - the statically-typed value to format into a String
Throws:
NullPointerException - if value is null

remove

Object remove(DefaultOptionMap x0)
Description copied from class: OptionParser
the destructor for a mapping in the magic-typed hashtable.
Overrides:
remove in class OptionParser

setOption

Object setOption(DefaultOptionMap x0,
                 Object x1)
Description copied from class: OptionParser
the mutator for the magic-typed hashtable stunt.
Overrides:
setOption in class OptionParser

getOption

Object getOption(DefaultOptionMap x0)
Description copied from class: OptionParser
the accessor for the magic-typed hashtable stunt.
Overrides:
getOption in class OptionParser

setString

Object setString(DefaultOptionMap x0,
                 String x1)
Description copied from class: OptionParser
uses parse() and setOption() so that any changes in parsing will automatically be applied to setString().
Overrides:
setString in class OptionParser

parse

public File parse(String s)
Description copied from class: OptionParser
the ability to parse a string to an object of type T. All concrete versions of this class must override this method to provide some sort of parser implementation.
Overrides:
parse in class OptionParser
Parameters:
s - The String to be parsed, must represent the absolute path of the File to be created.
Returns:
The File object corresponding to path "p".

getDefault

public Object getDefault()
Overrides:
getDefault in class OptionParser
Following copied from class: edu.rice.cs.drjava.config.OptionParser
Returns:
the default value