ValueMap - 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.common.value
Interface ValueMap

All Known Subinterfaces:: ComponentPreferences, PortletPreferences, Preferences

All Known Implementing Classes:: ComponentPreferencesPlugin, MappedPreferences, MapPreferences, PortletPreferencesPlugin, SimpleValueMap

public interface ValueMap

Method Summary

java.util.Set getKeys()
          Return the key set of the map.

Value getValue(java.lang.String key)
          Return the value for the given key or null if it does not exist.

void setValue(java.lang.String key, Value value)
          Update the value of the given key.

Method Detail

getKeys

public java.util.Set getKeys()

Return the key set of the map.

getValue

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

Return the value for the given key or null if it does not exist.

Parameters:: key - the requested key
Returns:: the requested value or null if it does not exist
Throws:: java.lang.IllegalArgumentException - if the key is null

setValue

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

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.

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