|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Objectorg.seasar.portlet.util.PortletPreferencesUtil
public class PortletPreferencesUtil
This class is a utility class to use PortletPreference on Seasar2 environment.
コンストラクタの概要 | |
---|---|
PortletPreferencesUtil()
|
メソッドの概要 | |
---|---|
static java.util.Map |
getMap()
Returns a Map of the preferences. |
static java.util.Enumeration |
getNames()
Returns all of the keys that have an associated value, or an empty Enumeration if no keys are
available. |
static javax.portlet.PortletPreferences |
getPortletPreferences()
|
static java.lang.String |
getValue(java.lang.String key,
java.lang.String def)
Returns the first String value associated with the specified key of this preference. |
static java.lang.String[] |
getValues(java.lang.String key,
java.lang.String[] def)
Returns the String array value associated with the specified key in this preference. |
static boolean |
isReadOnly(java.lang.String key)
Returns true, if the value of this key cannot be modified by the user. |
static void |
reset(java.lang.String key)
Resets or removes the value associated with the specified key. |
static void |
setValue(java.lang.String key,
java.lang.String value)
Associates the specified String value with the specified key in this preference. |
static void |
setValues(java.lang.String key,
java.lang.String[] values)
Associates the specified String array value with the specified key in this preference. |
static void |
store()
Commits all changes made to the preferences via the set methods in the persistent store. |
クラス java.lang.Object から継承されたメソッド |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
コンストラクタの詳細 |
---|
public PortletPreferencesUtil()
メソッドの詳細 |
---|
public static javax.portlet.PortletPreferences getPortletPreferences()
public static boolean isReadOnly(java.lang.String key)
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
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.
java.lang.IllegalArgumentException
- if key
is null
.public static java.lang.String getValue(java.lang.String key, java.lang.String def)
key
- key for which the associated value is to be returneddef
- 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.
java.lang.IllegalArgumentException
- if key
is null
. (A
null
value for def
is permitted.)getValues(String, String[])
public static java.lang.String[] getValues(java.lang.String key, java.lang.String[] def)
Returns the specified default if there is no value associated with the key, or if the backing store is inaccessible.
If the implementation supports stored defaults and such a default exists and is accessible, it is used in favor of the specified default.
key
- key for which associated value is to be returned.def
- 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.
java.lang.IllegalArgumentException
- if key
is null
. (A
null
value for def
is permitted.)getValue(String,String)
public static void setValue(java.lang.String key, java.lang.String value) throws java.io.IOException
The key cannot be null
, but null
values
for the value parameter are allowed.
key
- key with which the specified value is to be associated.value
- value to be associated with the specified key.
java.io.IOException
- if this preference cannot be modified for this request
java.lang.IllegalArgumentException
- if key is null
,
or key.length()
or value.length
are to long. The maximum length
for key and value are implementation specific.setValues(String, String[])
public static void setValues(java.lang.String key, java.lang.String[] values) throws java.io.IOException
The key cannot be null
, but null
values
in the values parameter are allowed.
key
- key with which the value is to be associatedvalues
- values to be associated with key
java.lang.IllegalArgumentException
- if key is null
, or
key.length()
is to long or value.size
is to large. The maximum
length for key and maximum size for value are implementation specific.
java.io.IOException
- if this preference cannot be modified for this requestsetValue(String,String)
public static java.util.Enumeration getNames()
Enumeration
if no keys are
available.
Enumeration
if no keys are
available.public static java.util.Map getMap()
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
.
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 static void reset(java.lang.String key) throws java.io.IOException
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.
key
- to reset
java.lang.IllegalArgumentException
- if key is null
.
java.io.IOException
- if this preference cannot be modified for this requestpublic static void store() throws java.io.IOException
set
methods in the persistent store.
If this call returns succesfull, all changes are made persistent. If this call fails, no changes are made in the persistent store. This call is an atomic operation regardless of how many preference attributes have been modified.
All changes made to preferences not followed by a call
to the store
method are discarded when the
portlet finishes the processAction
method.
If a validator is defined for this preferences in the
deployment descriptor, this validator is called before
the actual store is performed to check wether the given
preferences are vaild. If this check fails a
ValidatorException
is thrown.
java.io.IOException
- if changes cannot be written into
the backend store
javax.portlet.ValidatorException
- if the validation performed by the
associated validator fails
java.lang.IllegalStateException
- if this method is called inside a render callPreferencesValidator
|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |