org.sakaiproject.cheftool
Class PortletConfig

java.lang.Object
  org.sakaiproject.cheftool.PortletConfig

All Implemented Interfaces:

Map

public class PortletConfig
extends Object
implements Map

Provides read access to tool parameters, which are (name, value) pairs. Write access is not allowed. This provides an unmodifiable Map that looks first in the tool configuration, then in the tool registration, then in the servlet configuration. The values in the tool configuration may have been configured by the end-user, the values in the tool registration are defaulted in the tool registration file, and the values in the servlet configuration come from web.xml and cannot be modified by the user.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

void	clear() Unsupported operation
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set	entrySet()
Object	get(Object key)
String[]	get3InitParameter(String name) Special non-jetspeed imitation: get three possible init parameter values: [0] from servlet config [1] from tool registration [2] from tool config nulls if not present
String	getInitParameter(String name)
String	getInitParameter(String name, String dflt)
Map	getInitParameters()
String	getTitle()
boolean	isEmpty()
Set	keySet()
Object	put(Object key, Object value) Unsupported operation
void	putAll(Map t) Unsupported operation
Object	remove(Object key) Unsupported operation
int	size()
Collection	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

Method Detail

getInitParameter

public String getInitParameter(String name,
                               String dflt)

getInitParameter

public String getInitParameter(String name)

getInitParameters

public Map getInitParameters()

getTitle

public String getTitle()

get3InitParameter

public String[] get3InitParameter(String name)

Special non-jetspeed imitation: get three possible init parameter values: [0] from servlet config [1] from tool registration [2] from tool config nulls if not present

clear

public void clear()

Unsupported operation

Specified by:

clear in interface Map

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map

entrySet

public Set entrySet()

Specified by:

entrySet in interface Map

get

public Object get(Object key)

Specified by:

get in interface Map

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map

keySet

public Set keySet()

Specified by:

keySet in interface Map

put

public Object put(Object key,
                  Object value)

Unsupported operation

Specified by:

put in interface Map

putAll

public void putAll(Map t)

Unsupported operation

Specified by:

putAll in interface Map

remove

public Object remove(Object key)

Unsupported operation

Specified by:

remove in interface Map

size

public int size()

Specified by:

size in interface Map

values

public Collection values()

Specified by:

values in interface Map