com.liferay.portlet
Class BasePreferencesImpl

java.lang.Object
  com.liferay.portlet.BasePreferencesImpl

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

PortalPreferencesImpl, PortletPreferencesImpl

public abstract class BasePreferencesImpl
extends java.lang.Object
implements java.io.Serializable

Author:

Alexander Chow

See Also:

Serialized Form

Constructor Summary

BasePreferencesImpl(long companyId, long ownerId, int ownerType, java.util.Map<java.lang.String,Preference> preferences)

Method Summary

protected java.lang.String	getActualValue(java.lang.String value)
protected java.lang.String[]	getActualValues(java.lang.String[] values)
protected long	getCompanyId()
java.util.Map<java.lang.String,java.lang.String[]>	getMap()
protected java.util.Map<java.lang.String,Preference>	getModifiedPreferences()
java.util.Enumeration<java.lang.String>	getNames()
protected java.util.Map<java.lang.String,Preference>	getOriginalPreferences()
long	getOwnerId()
int	getOwnerType()
protected java.util.Map<java.lang.String,Preference>	getPreferences()
java.lang.String	getValue(java.lang.String key, java.lang.String def)
java.lang.String[]	getValues(java.lang.String key, java.lang.String[] def)
protected java.lang.String	getXmlSafeValue(java.lang.String value)
protected java.lang.String[]	getXmlSafeValues(java.lang.String[] values)
boolean	isReadOnly(java.lang.String key)
void	reset()
abstract void	reset(java.lang.String key)
void	setValue(java.lang.String key, java.lang.String value)
void	setValues(java.lang.String key, java.lang.String[] values)
abstract void	store()

Methods inherited from class java.lang.Object

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

Constructor Detail

BasePreferencesImpl

public BasePreferencesImpl(long companyId,
                           long ownerId,
                           int ownerType,
                           java.util.Map<java.lang.String,Preference> preferences)

Method Detail

getMap

public java.util.Map<java.lang.String,java.lang.String[]> getMap()

getNames

public java.util.Enumeration<java.lang.String> getNames()

getOwnerId

public long getOwnerId()

getOwnerType

public int getOwnerType()

getValue

public java.lang.String getValue(java.lang.String key,
                                 java.lang.String def)

getValues

public java.lang.String[] getValues(java.lang.String key,
                                    java.lang.String[] def)

isReadOnly

public boolean isReadOnly(java.lang.String key)

reset

public void reset()

reset

public abstract void reset(java.lang.String key)
                    throws javax.portlet.ReadOnlyException

Throws:

javax.portlet.ReadOnlyException

setValue

public void setValue(java.lang.String key,
                     java.lang.String value)
              throws javax.portlet.ReadOnlyException

Throws:

javax.portlet.ReadOnlyException

setValues

public void setValues(java.lang.String key,
                      java.lang.String[] values)
               throws javax.portlet.ReadOnlyException

Throws:

javax.portlet.ReadOnlyException

store

public abstract void store()
                    throws java.io.IOException,
                           javax.portlet.ValidatorException

Throws:

java.io.IOException

javax.portlet.ValidatorException

getActualValue

protected java.lang.String getActualValue(java.lang.String value)

getActualValues

protected java.lang.String[] getActualValues(java.lang.String[] values)

getCompanyId

protected long getCompanyId()

getModifiedPreferences

protected java.util.Map<java.lang.String,Preference> getModifiedPreferences()

getOriginalPreferences

protected java.util.Map<java.lang.String,Preference> getOriginalPreferences()

getPreferences

protected java.util.Map<java.lang.String,Preference> getPreferences()

getXmlSafeValue

protected java.lang.String getXmlSafeValue(java.lang.String value)

getXmlSafeValues

protected java.lang.String[] getXmlSafeValues(java.lang.String[] values)