com.cc.framework.http
Interface AttributeAccess

public interface AttributeAccess

Interface for classes which provide access to named attributes.

Since:

1.0

Version:

$Revision: 1.9 $

Author:

Harald Schulz

Method Summary

void	clearAttributes() Clears all known names/values.
java.lang.Object	getAttribute(java.lang.String name) Returns the value of the named attribute as an object, or null if no attribute of the given name exists.
java.util.Enumeration	getAttributeNames() Returns an Enumeration containing the names of the attributes available to this request.
void	removeAttribute(java.lang.String name) Removes an attribute from this request.
void	setAttribute(java.lang.String name, java.lang.Object obj) Stores an attribute in this request.

Method Detail

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

Returns the value of the named attribute as an object, or null if no attribute of the given name exists.

Parameters:

name - A String specifying the name of the attribute.

Returns:

an Object containing the value of the attribute, or null if the attribute does not exist

getAttributeNames

public java.util.Enumeration getAttributeNames()

Returns an Enumeration containing the names of the attributes available to this request. This method returns an empty Enumeration if the request has no attributes available to it.

Returns:

an Enumeration of strings containing the names of the request's attributes

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object obj)

Stores an attribute in this request. Attributes are reset between requests.

Parameters:

name - A String specifying the name of the attribute

obj - The Object to be stored

removeAttribute

public void removeAttribute(java.lang.String name)

Removes an attribute from this request. This method is not generally needed as attributes only persist as long as the request is being handled. Attribute names should follow the same conventions as package names.

Parameters:

name - a String specifying the name of the attribute to remove

clearAttributes

public void clearAttributes()

Clears all known names/values.