ecologylab.appframework.types.prefs
Class PrefSet

java.lang.Object
  ecologylab.generic.Debug
      ecologylab.xml.ElementState
          ecologylab.appframework.types.prefs.PrefSet

All Implemented Interfaces:

ApplicationPropertyNames, FieldTypes, XMLTranslationExceptionTypes, java.lang.Cloneable

public class PrefSet
extends ElementState
implements ApplicationPropertyNames, java.lang.Cloneable

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.DeclarationStyle, ElementState.xml_attribute, ElementState.xml_bind_from, ElementState.xml_bind_to, ElementState.xml_class, ElementState.xml_classes, ElementState.xml_collection, ElementState.xml_format, ElementState.xml_leaf, ElementState.xml_map, ElementState.xml_nested, ElementState.xml_nowrap, ElementState.xml_other_tags, ElementState.xml_scope, ElementState.xml_tag, ElementState.xml_text

Field Summary

Fields inherited from class ecologylab.xml.ElementState

CDATA, NORMAL, UTF16, UTF16_LE, UTF8

Fields inherited from interface ecologylab.appframework.ApplicationPropertyNames

CODEBASE, FRAME, GO_PREFIX, PREFERENCES_SET, PREFERENCES_SET_ASSET

Fields inherited from interface ecologylab.xml.FieldTypes

ATTRIBUTE, AWFUL_OLD_NESTED_ELEMENT, BAD_FIELD, COLLECTION_ELEMENT, COLLECTION_SCALAR, IGNORED_ATTRIBUTE, IGNORED_ELEMENT, LEAF, MAP_ELEMENT, MAP_SCALAR, NAME_SPACE_ATTRIBUTE, NAME_SPACE_LEAF_NODE, NAME_SPACE_MASK, NAME_SPACE_NESTED_ELEMENT, NAMESPACE_IGNORED_ELEMENT, NAMESPACE_TRIAL_ELEMENT, NESTED_ELEMENT, PSEUDO_FIELD_DESCRIPTOR, ROOT, TEXT_ELEMENT, TEXT_NODE_VALUE, UNSET_TYPE, WRAPPER, 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.
void	append(PrefSet jNLPPrefSet)
Pref<?>	clearPref(java.lang.String key) Remove the Pref from this, and from the global set.
PrefSet	clone()
boolean	containsKey(java.lang.String key)
Pref<?>	get(java.lang.String k)
java.util.Set<java.lang.String>	keySet()
static PrefSet	load(ParsedURL purl, TranslationScope translationSpace) Read Pref declarations from a file or across the net.
static PrefSet	load(java.lang.String filename, TranslationScope translationSpace) Read Pref declarations from a file or across the net.
static PrefSet	loadFromCharSequence(java.lang.String prefXML, TranslationScope translationSpace) Read Pref declarations from a file or across the net.
void	put(java.lang.String k, Pref<?> object)
java.util.Collection<Pref<?>>	values()

Methods inherited from class ecologylab.xml.ElementState

buildDOM, buildDOM, buildDOM, buildDOM, buildDOM, buildDOMFromXMLCharSequence, buildDOMFromXMLString, checkAnnotation, classDescriptor, createParentDirs, getChildFieldAccessors, getElementStateById, getFieldDescriptors, getNestedNameSpace, getTextNodeString, hasScalarTextField, lookupNestedNameSpace, parent, recycle, setDeclarationStyle, 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, getClass, hashCode, notify, notifyAll, wait, wait, wait

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.

Parameters:

pref -

Returns:

load

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

Read Pref declarations from a file or across the net.

Parameters:

purl -

translationSpace -

Returns:

Throws:

XMLTranslationException

load

public static PrefSet load(java.lang.String filename,
                           TranslationScope translationSpace)
                    throws XMLTranslationException

Read Pref 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

loadFromCharSequence

public static PrefSet loadFromCharSequence(java.lang.String prefXML,
                                           TranslationScope translationSpace)
                                    throws XMLTranslationException

Read Pref 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

clearPref

public Pref<?> clearPref(java.lang.String key)

Remove the Pref from this, and from the global set.

Parameters:

key -

Returns:

clone

public PrefSet clone()

Overrides:

clone in class java.lang.Object

See Also:

ecologylab.xml.types.element.HashMapState#clone()

values

public java.util.Collection<Pref<?>> values()

append

public void append(PrefSet jNLPPrefSet)

keySet

public java.util.Set<java.lang.String> keySet()

get

public Pref<?> get(java.lang.String k)

put

public void put(java.lang.String k,
                Pref<?> object)

containsKey

public boolean containsKey(java.lang.String key)