FileDocCategorySizeDatePackage
FilterDef.javaAPI DocGlassfish v2 API5290Fri May 04 22:32:08 BST 2007org.apache.catalina.deploy

FilterDef

public class FilterDef extends Object implements Serializable
Representation of a filter definition for a web application, as represented in a <filter> element in the deployment descriptor.
author
Craig R. McClanahan
version
$Revision: 1.3 $ $Date: 2007/05/05 05:32:08 $

Fields Summary
private String
description
The description of this filter.
private String
displayName
The display name of this filter.
private String
filterClass
The fully qualified name of the Java class that implements this filter.
private String
filterName
The name of this filter, which must be unique among the filters defined for a particular web application.
private String
largeIcon
The large icon associated with this filter.
private Map
parameters
The set of initialization parameters for this filter, keyed by parameter name.
private String
smallIcon
The small icon associated with this filter.
Constructors Summary
Methods Summary
public voidaddInitParameter(java.lang.String name, java.lang.String value)
Add an initialization parameter to the set of parameters associated with this filter.

param
name The initialization parameter name
param
value The initialization parameter value


        parameters.put(name, value);
public java.lang.StringgetDescription()


       
        return (this.description);
public java.lang.StringgetDisplayName()


       
        return (this.displayName);
public java.lang.StringgetFilterClass()


       
        return (this.filterClass);
public java.lang.StringgetFilterName()


       
        return (this.filterName);
public java.lang.StringgetLargeIcon()


       
        return (this.largeIcon);
public java.util.MapgetParameterMap()


       

        return (this.parameters);
public java.lang.StringgetSmallIcon()


       
        return (this.smallIcon);
public voidsetDescription(java.lang.String description)

        this.description = description;
public voidsetDisplayName(java.lang.String displayName)

        this.displayName = displayName;
public voidsetFilterClass(java.lang.String filterClass)

        this.filterClass = filterClass;
public voidsetFilterName(java.lang.String filterName)

        this.filterName = filterName;
public voidsetLargeIcon(java.lang.String largeIcon)

        this.largeIcon = largeIcon;
public voidsetSmallIcon(java.lang.String smallIcon)

        this.smallIcon = smallIcon;
public java.lang.StringtoString()
Render a String representation of this object.


        StringBuffer sb = new StringBuffer("FilterDef[");
        sb.append("filterName=");
        sb.append(this.filterName);
        sb.append(", filterClass=");
        sb.append(this.filterClass);
        sb.append("]");
        return (sb.toString());