ecologylab.appframework.types.prefs
Class PrefFile

java.lang.Object
  ecologylab.generic.Debug
      ecologylab.xml.ElementState
          ecologylab.xml.types.element.ArrayListState
              ecologylab.appframework.types.prefs.Pref<java.io.File>
                  ecologylab.appframework.types.prefs.PrefFile

All Implemented Interfaces:

OptimizationTypes, Mappable<java.lang.String>, XMLTranslationExceptionTypes, java.lang.Cloneable, java.lang.Iterable, java.util.Collection, java.util.List

public class PrefFile
extends Pref<java.io.File>

Pref indicating a File. Stores a value that indicates either an absolute path, or one relative to the code base or application data dir for the application using the Pref.

Author:

ross, Zachary O. Toups (toupsz@cs.tamu.edu)

Nested Class Summary

Nested classes/interfaces inherited from class ecologylab.xml.ElementState

ElementState.ClassToCollectionMap, ElementState.DeclarationStyle, ElementState.xml_attribute, ElementState.xml_class, ElementState.xml_classes, ElementState.xml_collection, ElementState.xml_leaf, ElementState.xml_map, ElementState.xml_nested, ElementState.xml_tag

Field Summary

static int	ABSOLUTE_PATH Indicates that value is an absolute path.
static int	APP_DATA_DIR Indicates that value is a path relative to the data directory associated with the application using this Pref.
static int	CODE_BASE Indicates that value is a path relative to the codebase of the application using this Pref.

Fields inherited from class ecologylab.xml.types.element.ArrayListState

set

Fields inherited from class ecologylab.xml.ElementState

CDATA, ESTIMATE_CHARS_PER_FIELD, FLOATING_PRECISION_OFF, MARSHALLING_PARAMS, NORMAL, UTF16, UTF16_LE, UTF8, XML_FILE_HEADER

Fields inherited from interface ecologylab.xml.OptimizationTypes

BAD_FIELD, COLLECTION_ELEMENT, COLLECTION_SCALAR, IGNORED_ATTRIBUTE, IGNORED_ELEMENT, LEAF_NODE_VALUE, MAP_ELEMENT, MAP_SCALAR, NAME_SPACE_ATTRIBUTE, NAME_SPACE_LEAF_NODE, NAME_SPACE_MASK, NAME_SPACE_NESTED_ELEMENT, NAMESPACE_IGNORED_ELEMENT, NAMESPACE_TRIAL_ELEMENT, OTHER_NESTED_ELEMENT, REGULAR_ATTRIBUTE, REGULAR_NESTED_ELEMENT, ROOT, UNSET_TYPE, XMLNS_ATTRIBUTE, XMLNS_IGNORED

Fields inherited from interface ecologylab.xml.XMLTranslationExceptionTypes

FILE_NOT_FOUND, IO_EXCEPTION, NULL_PURL, UNKNOWN

Constructor Summary

PrefFile()
No-argument constructor for XML translation.

PrefFile(java.io.File value)
Instantiate Pref to value

Method Summary

void	setValue(java.io.File newValue) Sets up this Pref object to be associated with newValue as an absolute path.
void	setValue(java.lang.String newValue, int pathContext) Sets up this Pref object to be associated with newValue as a path indicated by pathContext.

Methods inherited from class ecologylab.appframework.types.prefs.Pref

addPrefChangedListener, containsKey, getName, hasPref, key, lookupBoolean, lookupBoolean, lookupColor, lookupColor, lookupElementState, lookupFile, lookupFloat, lookupFloat, lookupInt, lookupInt, lookupPref, lookupString, lookupString, prefChanged, prefUpdated, print, toString, useAndSetPrefInt, usePrefBoolean, usePrefColor, usePrefFloat, usePrefInt, usePrefString, value

Methods inherited from class ecologylab.xml.types.element.ArrayListState

add, add, addAll, addAll, clear, clone, contains, containsAll, get, getArrayList, getCollection, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, recycle, remove, remove, removeAll, retainAll, set, set, size, subList, toArray, toArray, trimToSize

Methods inherited from class ecologylab.xml.ElementState

addNestedElement, addNestedElement, appendTextNodeString, buildDOM, buildDOM, buildDOM, buildDOM, buildDOM, buildDOMFromXMLCharSequence, buildDOMFromXMLString, checkAnnotation, convertNameStyles, createChildHook, fieldToXMLOptimizations, floatingPrecision, getElementStateById, getMap, getNestedNameSpace, getTextNodeString, leafElementFieldNames, lookupNestedNameSpace, optimizations, parent, postTranslationProcessingHook, preTranslationProcessingHook, setDeclarationStyle, setFieldUsingTypeRegistry, setFloatingPrecision, setParent, setUseDOMForTranslateTo, translateFromXML, translateFromXML, translateFromXML, translateFromXML, translateFromXML, translateFromXMLCharSequence, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOMCharSequence, translateFromXMLDOMCharSequence, translateFromXMLRootNode, translateFromXMLSAX, translateFromXMLSAX, translateFromXMLSAX, translateFromXMLSAX, translateFromXMLSAX, translateToDOM, translateToXML, translateToXML, translateToXML, translateToXML, writePrettyXML, writePrettyXML, writePrettyXML

Methods inherited from class ecologylab.generic.Debug

classSimpleName, closeLoggingFile, debug, debug, debug, debug, debugA, debugA, debugA, debugI, debugI, debugI, error, error, getClassName, getClassName, getInteractive, getPackageName, getPackageName, getPackageName, initialize, level, level, level, logToFile, print, print, println, println, println, println, println, println, printlnA, printlnA, printlnA, printlnI, printlnI, printlnI, printlnI, setLoggingFile, show, show, superString, toggleInteractive, toString, warning, warning, weird, weird

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

equals, hashCode

Field Detail

ABSOLUTE_PATH

public static final int ABSOLUTE_PATH

Indicates that value is an absolute path.

See Also:

Constant Field Values

CODE_BASE

public static final int CODE_BASE

Indicates that value is a path relative to the codebase of the application using this Pref.

See Also:

Constant Field Values

APP_DATA_DIR

public static final int APP_DATA_DIR

Indicates that value is a path relative to the data directory associated with the application using this Pref.

See Also:

Constant Field Values

Constructor Detail

PrefFile

public PrefFile()

No-argument constructor for XML translation.

PrefFile

public PrefFile(java.io.File value)

Instantiate Pref to value

Parameters:

value -

Method Detail

setValue

public void setValue(java.io.File newValue)

Sets up this Pref object to be associated with newValue as an absolute path.

Specified by:

setValue in class Pref<java.io.File>

See Also:

Pref.setValue(java.lang.Object)

setValue

public void setValue(java.lang.String newValue,
                     int pathContext)

Sets up this Pref object to be associated with newValue as a path indicated by pathContext.

Parameters:

newValue -

pathContext -