|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.pluto.internal.impl.PortletPreferencesImpl
public class PortletPreferencesImpl
Implementation of the javax.portlet.PortletPreferences
interface.
PortletPreferences
,
PortletPreferenceImpl
Constructor Summary | |
---|---|
PortletPreferencesImpl(PortletContainer container,
InternalPortletWindow window,
InternalPortletRequest request,
java.lang.Integer methodId)
Constructs an instance. |
Method Summary | |
---|---|
java.util.Map |
getMap()
Returns a Map of the preferences. |
java.util.Enumeration |
getNames()
Returns all of the keys that have an associated value, or an empty Enumeration if no keys are
available. |
java.lang.String |
getValue(java.lang.String key,
java.lang.String defaultValue)
Returns the first String value associated with the specified key of this preference. |
java.lang.String[] |
getValues(java.lang.String key,
java.lang.String[] defaultValues)
Returns the String array value associated with the specified key in this preference. |
boolean |
isReadOnly(java.lang.String key)
Returns true, if the value of this key is defined as read-only and thus cannot be modified by the user. |
void |
reset(java.lang.String key)
Resets or removes the value associated with the specified key. |
void |
setValue(java.lang.String key,
java.lang.String value)
Associates the specified String value with the specified key in this preference. |
void |
setValues(java.lang.String key,
java.lang.String[] values)
Associates the specified String array value with the specified key in this preference. |
void |
store()
Stores the portlet preferences to a persistent storage. |
java.lang.String |
toString()
Returns the string representation of this object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public PortletPreferencesImpl(PortletContainer container, InternalPortletWindow window, InternalPortletRequest request, java.lang.Integer methodId)
container
- the portlet container.window
- the internal portlet window.request
- the internal portlet request.methodId
- the request method ID: render request or action request.Method Detail |
---|
public boolean isReadOnly(java.lang.String key)
PortletPreferences
Modifiable preferences can be changed by the
portlet in any standard portlet mode (EDIT, HELP, VIEW
).
Per default every preference is modifiable.
Read-only preferences cannot be changed by the
portlet in any standard portlet mode, but inside of custom modes,
like the CONFIG
mode, it may be allowed changing them.
Preferences are read-only, if they are defined in the
deployment descriptor with read-only
set to true
,
or if the portlet container restricts write access.
Note that even if this call returns false
and the
preference key is modifiable in general it does not mean that it
is modifiable in the scope of the current request, e.g. if this
request is a render request.
isReadOnly
in interface PortletPreferences
public java.lang.String getValue(java.lang.String key, java.lang.String defaultValue)
PortletPreferences
null
value is treated as a non-existent value.
getValue
in interface PortletPreferences
key
- key for which the associated value is to be returneddefaultValue
- the value to be returned in the event that there is no
value available associated with this key
.
key
, or def
if no value is associated with key
, or the backing
store is inaccessible.PortletPreferences.getValues(String, String[])
public java.lang.String[] getValues(java.lang.String key, java.lang.String[] defaultValues)
PortletPreferences
Returns the specified default if there is no value
associated with the key, or if the backing store is inaccessible.
A null
value is treated as a non-existent value.
If the implementation supports stored defaults and such a default exists and is accessible, it is used in favor of the specified default.
getValues
in interface PortletPreferences
key
- key for which associated value is to be returned.defaultValues
- the value to be returned in the event that this
preference node has no value associated with key
or the associated value cannot be interpreted as a String array,
or the backing store is inaccessible.
key
, or def
if the
associated value does not exist.PortletPreferences.getValue(String,String)
public void setValue(java.lang.String key, java.lang.String value) throws ReadOnlyException
PortletPreferences
The key cannot be null
, but null
values
for the value parameter are allowed.
If the same key contained already a String
or String[]
value it must be replaced by the new value.
setValue
in interface PortletPreferences
key
- key with which the specified value is to be associated.value
- value to be associated with the specified key.
ReadOnlyException
- if this preference cannot be modified for this requestPortletPreferences.setValues(String, String[])
public void setValues(java.lang.String key, java.lang.String[] values) throws ReadOnlyException
PortletPreferences
The key cannot be null
, but null
values
in the values parameter are allowed.
If the same key contained already a String
or String[]
value it must be replaced by the new value.
setValues
in interface PortletPreferences
key
- key with which the value is to be associatedvalues
- values to be associated with key
ReadOnlyException
- if this preference cannot be modified for this requestPortletPreferences.setValue(String,String)
public java.util.Enumeration getNames()
PortletPreferences
Enumeration
if no keys are
available.
getNames
in interface PortletPreferences
Enumeration
if no keys are
available.public java.util.Map getMap()
PortletPreferences
Map
of the preferences.
The values in the returned Map
are from type
String array (String[]
).
If no preferences exist this method returns an empty Map
.
getMap
in interface PortletPreferences
Map
containing preference names as
keys and preference values as map values, or an empty Map
if no preference exist. The keys in the preference
map are of type String. The values in the preference map are of type
String array (String[]
).public void reset(java.lang.String key) throws ReadOnlyException
PortletPreferences
If this implementation supports stored defaults, and there is such a default for the specified preference, the given key will be reset to the stored default.
If there is no default available the key will be removed.
reset
in interface PortletPreferences
key
- to reset
ReadOnlyException
- if this preference cannot be modified for this requestpublic void store() throws java.io.IOException, ValidatorException
processAction()
method.
store
in interface PortletPreferences
java.lang.IllegalStateException
- if this method is not invoked within
processAction()
method.
ValidatorException
- if the portlet preferences are not valid.
java.io.IOException
- if an error occurs with the persistence mechanism.internalStore()
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |