org.eclipse.jst.j2ee.webapplication
Interface Filter

All Superinterfaces:
CompatibilityDescriptionGroup, DescriptionGroup, J2EEEObject

public interface Filter
extends CompatibilityDescriptionGroup

Declares a filter in the web application application. The filter is mapped to either a servlet or a URL pattern in the filter-mapping element, using the filter-name value to reference. Filters can access the initialization parameters declared in the deployment descriptor at runtime via the FilterConfig interface.


Method Summary
 JavaClass getFilterClass()
           
 java.lang.String getFilterClassName()
           
 EList getInitParams()
           
 EList getInitParamValues()
          Returns the value of the 'Init Param Values' containment reference list.
 java.lang.String getName()
           
 void setFilterClass(JavaClass value)
           
 void setFilterClassName(java.lang.String filterClassName)
           
 void setName(java.lang.String value)
           
 
Methods inherited from interface org.eclipse.jst.j2ee.common.CompatibilityDescriptionGroup
getDescription, getDisplayName, getLargeIcon, getSmallIcon, setDescription, setDescriptionGen, setDisplayName, setDisplayNameGen, setLargeIcon, setLargeIconGen, setSmallIcon, setSmallIconGen
 
Methods inherited from interface org.eclipse.jst.j2ee.common.DescriptionGroup
getDescriptions, getDisplayNames, getIcons
 

Method Detail

getFilterClassName

public java.lang.String getFilterClassName()

setFilterClassName

public void setFilterClassName(java.lang.String filterClassName)

getName

public java.lang.String getName()
Returns:
The value of the Name attribute The logical name of the filter. This name is used to map the filter.

setName

public void setName(java.lang.String value)
Parameters:
value - The new value of the Name attribute

getInitParams

public EList getInitParams()
Returns:
The list of InitParams references The init-params contain a name//value pairs as initialization params for the filter

getFilterClass

public JavaClass getFilterClass()
Returns:
The FilterClass reference The fully qualified classname of the filter.

setFilterClass

public void setFilterClass(JavaClass value)

getInitParamValues

public EList getInitParamValues()
Returns the value of the 'Init Param Values' containment reference list. The list contents are of type ParamValue.

If the meaning of the 'Init Param Values' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Init Param Values' containment reference list.
See Also:
WebapplicationPackage.getFilter_InitParamValues()