当前页面: 在线文档首页 > JBOSS Portal 2.2 API 英文版文档

PortletController.PreferencesContextImpl - JBOSS Portal 2.2 API 英文版文档

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.jboss.portal.portlet.test
Class PortletController.PreferencesContextImpl

java.lang.Object
  org.jboss.portal.portlet.test.PortletController.PreferencesContextImpl

All Implemented Interfaces:

PreferencesContext

Enclosing class:

PortletController

---

protected class PortletController.PreferencesContextImpl

extends java.lang.Object

implements PreferencesContext

---

Constructor Summary

PortletController.PreferencesContextImpl(Component component, UserInterceptor.User user)

 

Method Summary
java.util.Set	getSystemKeys()           Return the merged key set.
Value	getSystemValue(java.lang.String key)           Return for a key a value or null if no suitable value is found.
java.util.Set	getUserKeys()           Return the key set of the map.
Value	getUserValue(java.lang.String key)           Return for a key a value or null if no suitable value is found.
boolean	isSystemReadOnly(java.lang.String key)           Say if the key is marked as read only or not.
void	setUserValue(java.lang.String key, Value value)           Update the value of the given key.

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

PortletController.PreferencesContextImpl

public PortletController.PreferencesContextImpl(Component component,
                                                UserInterceptor.User user)

Method Detail

getUserKeys

public java.util.Set getUserKeys()

Description copied from interface: PreferencesContext

Return the key set of the map.

Specified by:

getUserKeys in interface PreferencesContext

---

getUserValue

public Value getUserValue(java.lang.String key)
                   throws java.lang.IllegalArgumentException

Description copied from interface: PreferencesContext

Return for a key a value or null if no suitable value is found.

Specified by:

getUserValue in interface PreferencesContext

Parameters:

key - the requested key

Returns:

the found value or null

Throws:

java.lang.IllegalArgumentException - if the key or the array is null

---

setUserValue

public void setUserValue(java.lang.String key,
                         Value value)
                  throws java.lang.IllegalArgumentException,
                         java.lang.UnsupportedOperationException

Description copied from interface: PreferencesContext

Update the value of the given key. If the value object is null it means that the entry must be removed. Implementation can throw an unsupported operation exception when it is abnormal to perform an update.

Specified by:

setUserValue in interface PreferencesContext

Parameters:

key - the key to update

value - the new value

Throws:

java.lang.UnsupportedOperationException - if the operation is not supported

java.lang.IllegalArgumentException - if the key is null

---

getSystemKeys

public java.util.Set getSystemKeys()
                            throws java.lang.IllegalArgumentException

Description copied from interface: PreferencesContext

Return the merged key set.

Specified by:

getSystemKeys in interface PreferencesContext

Returns:

the system key set

Throws:

java.lang.IllegalArgumentException - if the array is null

---

getSystemValue

public Value getSystemValue(java.lang.String key)
                     throws java.lang.IllegalArgumentException

Description copied from interface: PreferencesContext

Return for a key a value or null if no suitable value is found.

Specified by:

getSystemValue in interface PreferencesContext

Parameters:

key - the requested key

Returns:

the found value or null

Throws:

java.lang.IllegalArgumentException - if the key or the array is null

---

isSystemReadOnly

public boolean isSystemReadOnly(java.lang.String key)
                         throws java.lang.IllegalArgumentException

Description copied from interface: PreferencesContext

Say if the key is marked as read only or not.

Specified by:

isSystemReadOnly in interface PreferencesContext

Parameters:

key - the requested key

Returns:

the read only value

Throws:

java.lang.IllegalArgumentException - if the key or the array is null

---

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---