站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > JBOSS Portal 2.6 API 英文版文档

MappedPreferenceSet - JBOSS Portal 2.6 API 英文版文档


org.jboss.portal.migration.model20.impl.preferences
Class MappedPreferenceSet

java.lang.Object
  extended byorg.jboss.portal.migration.model20.impl.preferences.MappedPreferenceSet
All Implemented Interfaces:
PreferenceSet
Direct Known Subclasses:
UserPrefSet20

public class MappedPreferenceSet
extends java.lang.Object
implements PreferenceSet

Version:
$Revision: 5449 $
Author:
Julien Viet

Field Summary
private  java.util.Set children
           
private  FQN fqn
           
 java.lang.Integer id
           
private static org.apache.log4j.Logger log
          Our logger.
protected  java.util.Map map
           
private  java.lang.String name
           
private  MappedPreferenceSet parent
           
 
Constructor Summary
MappedPreferenceSet()
          Hibernate constructor.
MappedPreferenceSet(java.lang.String name)
           
 
Method Summary
 void addChild(MappedPreferenceSet child)
           
 java.util.Set getChildren()
           
 java.util.Map getContent()
           
 MappedPreferenceSet getDescendant(FQN fqn)
           
 FQN getFQN()
           
 java.lang.Integer getID()
           
 java.lang.String getName()
           
 MappedPreferenceSet getParent()
           
 Preference getPreference(java.lang.String key)
          Return the preference for the given key.
 Value getValue(java.lang.String key)
          Return the value for the given key or null if it does not exist.
 boolean isReadOnly(java.lang.String key)
          Return the read only value for the given preference.
 java.util.Set keySet()
          Return the key set of all the preferences.
protected  MappedPreferenceSet newChild(java.lang.String name)
          Override to provide the right object.
protected  Preference newPreference(java.lang.String name, Value value, boolean readOnly)
          Override to provide the right object.
 void setChildren(java.util.Set children)
           
 void setContent(java.util.Map content)
           
protected  void setID(java.lang.Integer id)
          Called by hibernate.
protected  void setName(java.lang.String name)
          Called by hibernate.
 void setParent(MappedPreferenceSet parent)
           
 void setReadOnly(java.lang.String key, boolean readOnly)
          Update the read only value for the given key.
 void setValue(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
 

Field Detail

log

private static org.apache.log4j.Logger log
Our logger.


id

public java.lang.Integer id

parent

private MappedPreferenceSet parent

children

private java.util.Set children

name

private java.lang.String name

fqn

private FQN fqn

map

protected java.util.Map map
Constructor Detail

MappedPreferenceSet

public MappedPreferenceSet()
Hibernate constructor.


MappedPreferenceSet

public MappedPreferenceSet(java.lang.String name)
Method Detail

getID

public java.lang.Integer getID()

setID

protected void setID(java.lang.Integer id)
Called by hibernate.


getName

public java.lang.String getName()

setName

protected void setName(java.lang.String name)
Called by hibernate.


getParent

public MappedPreferenceSet getParent()

setParent

public void setParent(MappedPreferenceSet parent)

addChild

public void addChild(MappedPreferenceSet child)

getChildren

public java.util.Set getChildren()

setChildren

public void setChildren(java.util.Set children)

getDescendant

public MappedPreferenceSet getDescendant(FQN fqn)

getFQN

public FQN getFQN()

getContent

public java.util.Map getContent()

setContent

public void setContent(java.util.Map content)

keySet

public java.util.Set keySet()
Description copied from interface: PreferenceSet
Return the key set of all the preferences.

Specified by:
keySet in interface PreferenceSet

getPreference

public Preference getPreference(java.lang.String key)
Description copied from interface: PreferenceSet
Return the preference for the given key. If no preference exists it must return null.

Specified by:
getPreference in interface PreferenceSet
Parameters:
key - the requested key
Returns:
the requested preference or null if it does not exist

getValue

public Value getValue(java.lang.String key)
Description copied from interface: PreferenceSet
Return the value for the given key or null if it does not exist.

Specified by:
getValue in interface PreferenceSet
Parameters:
key - the requested key
Returns:
the requested value or null if it does not exist

setValue

public void setValue(java.lang.String key,
                     Value value)
Description copied from interface: PreferenceSet
Update the value of the given key. If the value object is null it means that the preference must be removed. Implementation can throw an unsupported operation exception when it is abnormal to perform an update.

Specified by:
setValue in interface PreferenceSet
Parameters:
key - the key to update
value - the new value

isReadOnly

public boolean isReadOnly(java.lang.String key)
Description copied from interface: PreferenceSet
Return the read only value for the given preference.

Specified by:
isReadOnly in interface PreferenceSet
Parameters:
key - the requested key
Returns:
the read only value

setReadOnly

public void setReadOnly(java.lang.String key,
                        boolean readOnly)
Description copied from interface: PreferenceSet
Update the read only value for the given key. Implementation can throw an unsupported operation exception when it is abnormal to perform an update.

Specified by:
setReadOnly in interface PreferenceSet
Parameters:
key - the key to update
readOnly - the new read only value

newChild

protected MappedPreferenceSet newChild(java.lang.String name)
Override to provide the right object.


newPreference

protected Preference newPreference(java.lang.String name,
                                   Value value,
                                   boolean readOnly)
Override to provide the right object.