org.eclipse.jst.j2ee.webapplication
Interface Filter

All Superinterfaces:
CompatibilityDescriptionGroup, DescriptionGroup, org.eclipse.emf.ecore.EObject, J2EEEObject, org.eclipse.emf.common.notify.Notifier

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()
           
 org.eclipse.emf.common.util.EList getInitParams()
           
 org.eclipse.emf.common.util.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
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

getFilterClassName

java.lang.String getFilterClassName()

setFilterClassName

void setFilterClassName(java.lang.String filterClassName)

getName

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

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

getInitParams

org.eclipse.emf.common.util.EList getInitParams()
Returns:
The list of InitParams references The init-params contain a name//value pairs as initialization params for the filter

getFilterClass

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

setFilterClass

void setFilterClass(JavaClass value)
Parameters:
l - The new value of the FilterClass reference

getInitParamValues

org.eclipse.emf.common.util.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()