com.liferay.portlet

Class BasePreferencesImpl

Object

com.liferay.portlet.BasePreferencesImpl

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

PortalPreferencesImpl, PortletPreferencesImpl

public abstract class BasePreferencesImpl
extends Object
implements Serializable

Author:

Alexander Chow, Shuyang Zhou

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BasePreferencesImpl(long ownerId, int ownerType, String xml, Map<String,Preference> preferences)

Method Summary

Modifier and Type	Method and Description
protected String	getActualValue(String value)
protected String[]	getActualValues(String[] values)
Map<String,String[]>	getMap()
protected Map<String,Preference>	getModifiedPreferences()
Enumeration<String>	getNames()
protected Map<String,Preference>	getOriginalPreferences()
protected String	getOriginalXML()
long	getOwnerId()
int	getOwnerType()
protected Map<String,Preference>	getPreferences()
String	getValue(String key, String def)
String[]	getValues(String key, String[] def)
protected String	getXMLSafeValue(String value)
protected String[]	getXMLSafeValues(String[] values)
protected boolean	isNull(String[] values)
boolean	isReadOnly(String key)
void	reset()
abstract void	reset(String key)
protected void	setOriginalPreferences(Map<String,Preference> originalPreferences)
protected void	setOriginalXML(String originalXML)
void	setValue(String key, String value)
void	setValues(String key, String[] values)
int	size()
abstract void	store()
protected String	toXML()

Methods inherited from class Object

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

Constructor Detail

BasePreferencesImpl

public BasePreferencesImpl(long ownerId,
                           int ownerType,
                           String xml,
                           Map<String,Preference> preferences)

Method Detail

getMap

public Map<String,String[]> getMap()

getNames

public Enumeration<String> getNames()

getOwnerId

public long getOwnerId()

getOwnerType

public int getOwnerType()

getValue

public String getValue(String key,
                       String def)

getValues

public String[] getValues(String key,
                          String[] def)

isReadOnly

public boolean isReadOnly(String key)

reset

public void reset()

reset

public abstract void reset(String key)
                    throws ReadOnlyException

Throws:

ReadOnlyException

setValue

public void setValue(String key,
                     String value)
              throws ReadOnlyException

Throws:

ReadOnlyException

setValues

public void setValues(String key,
                      String[] values)
               throws ReadOnlyException

Throws:

ReadOnlyException

size

public int size()

store

public abstract void store()
                    throws IOException,
                           ValidatorException

Throws:

IOException

ValidatorException

getActualValue

protected String getActualValue(String value)

getActualValues

protected String[] getActualValues(String[] values)

getModifiedPreferences

protected Map<String,Preference> getModifiedPreferences()

getOriginalPreferences

protected Map<String,Preference> getOriginalPreferences()

getOriginalXML

protected String getOriginalXML()

getPreferences

protected Map<String,Preference> getPreferences()

getXMLSafeValue

protected String getXMLSafeValue(String value)

getXMLSafeValues

protected String[] getXMLSafeValues(String[] values)

isNull

protected boolean isNull(String[] values)

setOriginalPreferences

protected void setOriginalPreferences(Map<String,Preference> originalPreferences)

setOriginalXML

protected void setOriginalXML(String originalXML)

toXML

protected String toXML()