org.apache.jetspeed.util
Class BaseConfig

java.lang.Object
  extended byjava.util.Dictionary
      extended byjava.util.Hashtable
          extended byorg.apache.jetspeed.util.BaseConfig
All Implemented Interfaces:
java.lang.Cloneable, Config, java.util.Map, java.io.Serializable
Direct Known Subclasses:
BasePortletConfig, BasePortletControlConfig, BasePortletControllerConfig

public class BaseConfig
extends java.util.Hashtable
implements Config

Defines a standard object configuration A Config provides the parameters passed in the current request as well as init parameters.

Version:
$Id: BaseConfig.java,v 1.4 2005/03/21 18:21:44 sgala Exp $
Author:
Raphaël Luta
See Also:
Serialized Form

Constructor Summary
BaseConfig()
           
 
Method Summary
 void addInitParameters(java.util.Map init_params)
          Used to override Portlet's parameters.
 java.lang.String getInitParameter(java.lang.String name)
          Returns a parameter (or null) that was given the controller.
 java.lang.String getInitParameter(java.lang.String name, java.lang.String defaultValue)
          Returns a parameter (or defaultValue) that was given the controller.
 java.util.Iterator getInitParameterNames()
          Returns the parameter names of this Config.
 java.util.Map getInitParameters()
          Retrieves the PortletController parameters
 java.lang.String getName()
          Returns the name for this configuration
 void setInitParameter(java.lang.String name, java.lang.Object value)
          Used to define a PortletController's parameter.if value is null, removes the key from the stored properties
 void setInitParameters(java.util.Map init_params)
          Used to define a Portlet's parameters.
 void setName(java.lang.String name)
          Sets the name of this configuration
 
Methods inherited from class java.util.Hashtable
clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

BaseConfig

public BaseConfig()
Method Detail

getName

public java.lang.String getName()
Returns the name for this configuration

Specified by:
getName in interface Config

setName

public void setName(java.lang.String name)
Sets the name of this configuration

Specified by:
setName in interface Config

setInitParameters

public void setInitParameters(java.util.Map init_params)
Used to define a Portlet's parameters.

Specified by:
setInitParameters in interface Config

addInitParameters

public void addInitParameters(java.util.Map init_params)
Used to override Portlet's parameters.

Specified by:
addInitParameters in interface Config

getInitParameters

public java.util.Map getInitParameters()
Retrieves the PortletController parameters

Specified by:
getInitParameters in interface Config

setInitParameter

public void setInitParameter(java.lang.String name,
                             java.lang.Object value)
Used to define a PortletController's parameter.if value is null, removes the key from the stored properties

Specified by:
setInitParameter in interface Config

getInitParameter

public java.lang.String getInitParameter(java.lang.String name)
Returns a parameter (or null) that was given the controller.

Specified by:
getInitParameter in interface Config

getInitParameter

public java.lang.String getInitParameter(java.lang.String name,
                                         java.lang.String defaultValue)
Returns a parameter (or defaultValue) that was given the controller.

Specified by:
getInitParameter in interface Config

getInitParameterNames

public java.util.Iterator getInitParameterNames()
Returns the parameter names of this Config.

Specified by:
getInitParameterNames in interface Config


Copyright © 2000-2005 Apache Software Foundation. All Rights Reserved.