org.jboss.portal.portlet.impl.jsr168.info
Class ContainerPreferenceInfo

java.lang.Object
  org.jboss.portal.portlet.impl.jsr168.info.ContainerPreferenceInfo

All Implemented Interfaces:

PreferenceInfo

public class ContainerPreferenceInfo
extends java.lang.Object
implements PreferenceInfo

Version:

$Revision: 6818 $

Author:

Julien Viet

Constructor Summary

ContainerPreferenceInfo(java.lang.String key, LocalizedString displayName, LocalizedString description, boolean readOnly, Value value)

Method Summary

Value	getDefaultValue() Return the value provided by the portlet.xml deployment descriptor.
LocalizedString	getDescription() Retrieves the localized description of the described preference.
LocalizedString	getDisplayName() Retrieves the localized display name of the described preference.
java.lang.String	getKey() Retrieves the key associated to the described preference.
java.lang.Boolean	isReadOnly() Return true if the preference is read-only, false otherwise or null if it cannot be determined.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContainerPreferenceInfo

public ContainerPreferenceInfo(java.lang.String key,
                               LocalizedString displayName,
                               LocalizedString description,
                               boolean readOnly,
                               Value value)

Method Detail

getKey

public java.lang.String getKey()

Description copied from interface: PreferenceInfo

Retrieves the key associated to the described preference.

Specified by:

getKey in interface PreferenceInfo

Returns:

the key associated to the described preference.

getDisplayName

public LocalizedString getDisplayName()

Description copied from interface: PreferenceInfo

Retrieves the localized display name of the described preference.

Specified by:

getDisplayName in interface PreferenceInfo

Returns:

the localized display name of the described preference.

See Also:

LocalizedString

getDescription

public LocalizedString getDescription()

Description copied from interface: PreferenceInfo

Retrieves the localized description of the described preference.

Specified by:

getDescription in interface PreferenceInfo

Returns:

the localized description of the described preference.

See Also:

LocalizedString

isReadOnly

public java.lang.Boolean isReadOnly()

Description copied from interface: PreferenceInfo

Return true if the preference is read-only, false otherwise or null if it cannot be determined.

Specified by:

isReadOnly in interface PreferenceInfo

Returns:

true if the described preference is read-only, false otherwise.

getDefaultValue

public Value getDefaultValue()

Return the value provided by the portlet.xml deployment descriptor.

Returns:

the preference value associated with this preference meta data