org.apache.jetspeed.om.registry
Interface CapabilityMap

All Known Implementing Classes:

BaseCapabilityMap

public interface CapabilityMap

The CapabilityMap interface represents a list that stores capabilities a client is capable of. It is accessed by the portlet container to get information about the client's capabilities.

The names of the capabilities are matched by the class variable names of the class Capability. To add a capability use the class variable name and not the internally used string value.

Version:

$Id: CapabilityMap.java,v 1.4 2005/03/21 18:21:37 sgala Exp $

Author:

Stephan Hesmer, Raphaël Luta

See Also:

Capability

Method Summary

void	addCapability(java.lang.String name) Adds the given capability
boolean	contains(java.lang.String capability) Checks if the argument capability is included in this map
boolean	containsAll(CapabilityMap map) Checks if the all the elements of argument capability map are included in the current one
java.util.Iterator	getCapabilities() Returns an enumeration of all capabilities a client is capabale of.
void	removeCapability(java.lang.String name) Removes the given capability

Method Detail

getCapabilities

public java.util.Iterator getCapabilities()

Returns an enumeration of all capabilities a client is capabale of.

Returns:

an enumeration of all capabilities

addCapability

public void addCapability(java.lang.String name)

Adds the given capability

Parameters:

name - the name of the new capability

removeCapability

public void removeCapability(java.lang.String name)

Removes the given capability

Parameters:

name - the name of the capability to be removed

contains

public boolean contains(java.lang.String capability)

Checks if the argument capability is included in this map

Returns:

true if the capability is supported

containsAll

public boolean containsAll(CapabilityMap map)

Checks if the all the elements of argument capability map are included in the current one

Parameters:

map - a CapabilityMap implementation to test

Returns:

true is all the elements the argument map are included in the current map.