ecologylab.appframework.types.prefs
Class PrefSet

java.lang.Object
  ecologylab.generic.Debug
      ecologylab.xml.ElementState
          ecologylab.xml.types.element.HashMapState<java.lang.String,Pref<?>>
              ecologylab.appframework.types.prefs.PrefSet

All Implemented Interfaces:

ApplicationPropertyNames, OptimizationTypes, XMLTranslationExceptionTypes, java.lang.Cloneable, java.util.Map<java.lang.String,Pref<?>>

public class PrefSet
extends HashMapState<java.lang.String,Pref<?>>
implements ApplicationPropertyNames

A serial set of Pref objects. Used for reading and writing (load and save). The static allPrefsMap in Pref is used for lookup.

Author:

Cae, andruid

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

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

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

map

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.appframework.ApplicationPropertyNames

CODEBASE, FRAME, GO_PREFIX, PREFERENCES_SET, PREFERENCES_SET_ASSET, USERINTERFACE_PREF

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

PrefSet()
No-argument constructor for XML translation.

Method Summary

Pref<?>	add(Pref<?> pref) Register the Pref, as well as adding it to the super ArrayListState.
protected void	createChildHook(ElementState child) Perform custom processing on the newly created child node, just before it is added to this.
static PrefSet	load(ParsedURL purl, TranslationSpace translationSpace) Read MetaPref declarations from a file or across the net.
static PrefSet	load(java.lang.String prefXML, TranslationSpace translationSpace) Read MetaPref declarations from a file or across the net.

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

clear, clone, containsKey, containsValue, entrySet, get, getMap, isEmpty, keySet, map, put, putAll, recycle, remove, size, values

Methods inherited from class ecologylab.xml.ElementState

addNestedElement, addNestedElement, appendTextNodeString, buildDOM, buildDOM, buildDOM, buildDOM, buildDOM, buildDOMFromXMLCharSequence, buildDOMFromXMLString, checkAnnotation, convertNameStyles, fieldToXMLOptimizations, floatingPrecision, getCollection, getElementStateById, 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, 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.Map

equals, hashCode

Constructor Detail

PrefSet

public PrefSet()

No-argument constructor for XML translation.

Method Detail

add

public Pref<?> add(Pref<?> pref)

Register the Pref, as well as adding it to the super ArrayListState.

Overrides:

add in class HashMapState<java.lang.String,Pref<?>>

Parameters:

pref -

Returns:

createChildHook

protected void createChildHook(ElementState child)

Perform custom processing on the newly created child node, just before it is added to this.

This is part of depth-first traversal during translateFromXML().

Add the entry to the category map.

Overrides:

createChildHook in class ElementState

Parameters:

child -

load

public static PrefSet load(ParsedURL purl,
                           TranslationSpace translationSpace)
                    throws XMLTranslationException

Read MetaPref declarations from a file or across the net.

Parameters:

purl -

translationSpace -

Returns:

Throws:

XMLTranslationException

load

public static PrefSet load(java.lang.String prefXML,
                           TranslationSpace translationSpace)
                    throws XMLTranslationException

Read MetaPref declarations from a file or across the net.

Parameters:

prefXML - - Preferences in an XML format; to be translated into a PrefSet.

translationSpace -

Returns:

Throws:

XMLTranslationException