|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.wcm.toolkit.server.util.prefs.WcmPrefsObject
Base preferences object class
Constructor Summary | |
WcmPrefsObject()
|
Method Summary | |
void |
clear()
Clears the data |
void |
clearAttributes()
CLears the temporary attributes map |
java.lang.Object |
clone()
|
protected static boolean |
convertToBoolean(java.lang.Object value)
|
protected static boolean |
convertToBoolean(java.lang.Object value,
boolean defaultValue)
|
protected static int |
convertToInt(java.lang.Object value)
|
protected static long |
convertToLong(java.lang.Object value)
|
protected static PrefsLabel |
convertToPrefsLabel(java.lang.Object value)
|
protected static PrefsLabel[] |
convertToPrefsLabelArray(java.lang.Object value)
|
boolean |
equals(java.lang.Object o)
|
java.lang.Object |
get(java.lang.String key)
Returns the value mapped to the key |
java.lang.Object |
getAttribute(java.lang.Object key)
Returns temporary attribute mapped to the key |
boolean |
getBoolean(java.lang.String key)
Returns the setting as a boolean |
java.lang.String |
getElementKey()
Returns the value of key attribute of this object |
int |
getInt(java.lang.String key)
Returns the value of a setting as Int |
PrefsLabel |
getLabel(java.lang.String key)
|
PrefsLabel[] |
getLabelArray(java.lang.String key)
Returns the value of a setting as PrefsLabel[] |
java.util.List |
getList(java.lang.String key)
Returns the value of a setting as List |
WcmString |
getLocalizedString(java.lang.String key)
Returns WcmString value mapped to the key |
java.lang.String |
getString(java.lang.String key)
Returns the setting as a String |
java.lang.String[] |
getStringArray(java.lang.String key)
Returns the value of a setting as String[] |
java.lang.String |
getVersion()
Returns the version number of the preference object |
protected void |
initialize()
In sub-classes, read the values from internal map using get methods into member variables. |
void |
load(org.w3c.dom.Document doc)
Loads the object from DOM Document |
void |
load(org.w3c.dom.Element element)
Loads the object from DOM Element |
void |
load(java.io.InputStream in)
Loads the object from an InputStream |
void |
load(java.lang.String xml)
Loads the object from a String |
static PrefsLabel |
loadLabel(org.w3c.dom.Element e)
|
static WcmPrefsObject |
loadPreferences(org.w3c.dom.Document doc)
|
static WcmPrefsObject |
loadPreferences(java.io.InputStream in)
|
static WcmPrefsObject |
loadPreferences(java.lang.String xml)
|
protected void |
persist()
In sub-classes, write the values from member variables into the internal map using put method. |
void |
put(java.lang.String key,
boolean value)
Sets a value as boolean |
void |
put(java.lang.String key,
int value)
Sets a value as int |
void |
put(java.lang.String key,
java.util.List value)
Sets a value as List |
void |
put(java.lang.String key,
PrefsLabel value)
|
void |
put(java.lang.String key,
PrefsLabel[] value)
|
void |
put(java.lang.String key,
java.lang.String value)
Sets a value as a String |
void |
put(java.lang.String key,
java.lang.String[] value)
Sets a value as String array |
void |
put(java.lang.String key,
WcmPrefsObject value)
Sets a value as WcmPrefsObject |
static void |
registerKey(java.lang.String sObjectKey,
java.lang.Class c)
|
java.lang.Object |
remove(java.lang.String key)
Removes the value mapped to the key |
void |
removeAttribute(java.lang.Object key)
Removes temporary attribute |
WcmString |
removeLocalizedString(java.lang.String key)
Removes the localized mapped to the key |
protected void |
saveToXML(java.io.Writer w)
Overwrite this method if you want to hanlde saving data yourself. |
void |
setAttribute(java.lang.Object key,
java.lang.Object value)
Sets temporary attribute |
void |
setElementKey(java.lang.String name)
Sets the value of the key attribute that is saved to xml |
void |
setVersion(java.lang.String version)
Sets the version number of the preference object |
byte[] |
toByteArrayXML()
Returns XML representation of this object in byte array form This method uses UTF-8 encoding |
java.lang.String |
toXML()
Returns XML representation of this object |
protected void |
writeEndSettingTag(java.io.Writer w)
|
protected void |
writeSetting(java.io.Writer w,
java.lang.String key,
boolean value)
|
protected void |
writeSetting(java.io.Writer w,
java.lang.String key,
boolean[] values)
write a boolean array |
protected void |
writeSetting(java.io.Writer w,
java.lang.String key,
int value)
|
protected void |
writeSetting(java.io.Writer w,
java.lang.String key,
java.util.List values)
|
protected void |
writeSetting(java.io.Writer w,
java.lang.String key,
long value)
|
protected void |
writeSetting(java.io.Writer w,
java.lang.String key,
PrefsLabel value)
|
protected void |
writeSetting(java.io.Writer w,
java.lang.String key,
PrefsLabel[] values)
|
protected void |
writeSetting(java.io.Writer w,
java.lang.String key,
java.lang.String value)
|
protected void |
writeSetting(java.io.Writer w,
java.lang.String key,
java.lang.String[] values)
|
protected void |
writeSetting(java.io.Writer w,
java.lang.String key,
WcmPrefsObject value)
|
protected void |
writeSetting(java.io.Writer w,
java.lang.String key,
WcmString value)
|
protected void |
writeStartSettingTag(java.io.Writer w,
java.lang.String sKey)
|
protected void |
writeStartSettingTag(java.io.Writer w,
java.lang.String key,
java.lang.String localizationKey)
|
void |
writeXML(java.io.Writer w)
Writes XML representation of this object to a Writer |
void |
writeXML(java.io.Writer w,
java.lang.String encoding)
Writes the XML representation of this object to a Writer. |
Methods inherited from class java.lang.Object |
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public WcmPrefsObject()
Method Detail |
public void clear()
public java.lang.String getVersion()
public void setVersion(java.lang.String version)
version
- public final java.lang.String getElementKey()
public final void setElementKey(java.lang.String name)
name
- public void setAttribute(java.lang.Object key, java.lang.Object value)
key
- value
- public java.lang.Object getAttribute(java.lang.Object key)
key
-
public void removeAttribute(java.lang.Object key)
key
- public void clearAttributes()
public void put(java.lang.String key, boolean value)
key
- value
- public void put(java.lang.String key, int value)
key
- value
- public void put(java.lang.String key, java.lang.String value)
key
- value
- public void put(java.lang.String key, java.lang.String[] value)
key
- value
- public void put(java.lang.String key, PrefsLabel value)
public void put(java.lang.String key, PrefsLabel[] value)
public void put(java.lang.String key, WcmPrefsObject value)
key
- value
- public void put(java.lang.String key, java.util.List value)
key
- value
- public java.lang.Object remove(java.lang.String key)
key
-
public WcmString removeLocalizedString(java.lang.String key)
key
-
public java.lang.Object get(java.lang.String key)
key
-
public WcmString getLocalizedString(java.lang.String key)
key
-
protected static boolean convertToBoolean(java.lang.Object value)
protected static boolean convertToBoolean(java.lang.Object value, boolean defaultValue)
public boolean getBoolean(java.lang.String key)
key
-
public PrefsLabel getLabel(java.lang.String key)
public java.lang.String getString(java.lang.String key)
key
-
protected static int convertToInt(java.lang.Object value)
protected static long convertToLong(java.lang.Object value)
protected static PrefsLabel[] convertToPrefsLabelArray(java.lang.Object value)
protected static PrefsLabel convertToPrefsLabel(java.lang.Object value)
public int getInt(java.lang.String key)
key
-
public java.lang.String[] getStringArray(java.lang.String key)
key
-
public java.util.List getList(java.lang.String key)
key
-
public PrefsLabel[] getLabelArray(java.lang.String key)
key
-
public final java.lang.String toXML() throws java.io.IOException
java.io.IOException
public final byte[] toByteArrayXML() throws java.io.IOException
java.io.IOException
public final void writeXML(java.io.Writer w) throws java.io.IOException
w
-
java.io.IOException
public final void writeXML(java.io.Writer w, java.lang.String encoding) throws java.io.IOException
w
- encoding
-
java.io.IOException
protected final void writeStartSettingTag(java.io.Writer w, java.lang.String key, java.lang.String localizationKey) throws java.io.IOException
java.io.IOException
protected final void writeStartSettingTag(java.io.Writer w, java.lang.String sKey) throws java.io.IOException
java.io.IOException
protected final void writeEndSettingTag(java.io.Writer w) throws java.io.IOException
java.io.IOException
protected final void writeSetting(java.io.Writer w, java.lang.String key, boolean value) throws java.io.IOException
java.io.IOException
protected final void writeSetting(java.io.Writer w, java.lang.String key, boolean[] values) throws java.io.IOException
w
- The Writer to write onkey
- The key to the arrayvalues
- The boolean array to write.
java.io.IOException
protected final void writeSetting(java.io.Writer w, java.lang.String key, PrefsLabel value) throws java.io.IOException
java.io.IOException
protected final void writeSetting(java.io.Writer w, java.lang.String key, int value) throws java.io.IOException
java.io.IOException
protected final void writeSetting(java.io.Writer w, java.lang.String key, long value) throws java.io.IOException
java.io.IOException
protected final void writeSetting(java.io.Writer w, java.lang.String key, java.lang.String value) throws java.io.IOException
java.io.IOException
protected final void writeSetting(java.io.Writer w, java.lang.String key, WcmString value) throws java.io.IOException
java.io.IOException
protected final void writeSetting(java.io.Writer w, java.lang.String key, PrefsLabel[] values) throws java.io.IOException
java.io.IOException
protected final void writeSetting(java.io.Writer w, java.lang.String key, java.lang.String[] values) throws java.io.IOException
java.io.IOException
protected final void writeSetting(java.io.Writer w, java.lang.String key, java.util.List values) throws java.io.IOException
java.io.IOException
protected final void writeSetting(java.io.Writer w, java.lang.String key, WcmPrefsObject value) throws java.io.IOException
java.io.IOException
protected void saveToXML(java.io.Writer w) throws java.io.IOException
w
- Writer object
java.io.IOException
- if any IO errors occur when writing the xmlprotected void initialize()
protected void persist()
public void load(java.lang.String xml) throws java.lang.Exception
xml
-
java.lang.Exception
public void load(java.io.InputStream in) throws java.lang.Exception
in
-
java.lang.Exception
public void load(org.w3c.dom.Document doc) throws java.lang.Exception
doc
-
java.lang.Exception
public void load(org.w3c.dom.Element element) throws java.lang.Exception
element
-
java.lang.Exception
public static void registerKey(java.lang.String sObjectKey, java.lang.Class c)
public static WcmPrefsObject loadPreferences(java.lang.String xml) throws java.lang.Exception
java.lang.Exception
public static WcmPrefsObject loadPreferences(java.io.InputStream in) throws java.lang.Exception
java.lang.Exception
public static WcmPrefsObject loadPreferences(org.w3c.dom.Document doc) throws java.lang.Exception
java.lang.Exception
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
java.lang.CloneNotSupportedException
public boolean equals(java.lang.Object o)
public static PrefsLabel loadLabel(org.w3c.dom.Element e)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |