|
Enhydra 5.1 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.enhydra.servlet.filter.FilterManager
This class maintains a set of Filters. Each filter is associated with an identification string (symbolic name). This ID string is used to retrieve a filter.
This class does not monitor the creation of filters. If you create one, you are responsible for adding it to this class. These public methods are the only things that modify the set of filters managed by this class.
Filter
Constructor Summary | |
FilterManager()
Create a new, empty, FilterManager. |
Method Summary | |
void |
add(java.lang.String filterID,
Filter filter,
java.lang.String description)
Add a Filter to the set. |
void |
delete(java.lang.String filterID)
Remove a Filter from the set. |
Filter |
get(java.lang.String filterID)
Look up a Filter by its identifier string. |
java.lang.String |
getDescription(java.lang.String filterID)
Look up a filter's description by its identifier string. |
java.lang.String[] |
getIDs()
Get all the names of the Filters currently being stored. |
java.lang.String |
getUniqueID(java.lang.String baseName)
Generate a unique filter id. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public FilterManager()
Method Detail |
public void add(java.lang.String filterID, Filter filter, java.lang.String description)
filterID
- The name to use to refer to the filter.filter
- The Filter to store.description
- A human readable description of this filter.public Filter get(java.lang.String filterID)
filterID
- The symbolic name to look up.
public java.lang.String getDescription(java.lang.String filterID)
filterID
- The symbolic name to look up.
public java.lang.String[] getIDs()
public void delete(java.lang.String filterID)
filterID
- The name of the Filter to remove.public java.lang.String getUniqueID(java.lang.String baseName)
baseName
- The initial name to use.
|
Enhydra 5.1 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |