Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.jboss.shrinkwrap.descriptor.api.webcommon30
Interface FilterType<T>

All Superinterfaces:
  org.jboss.shrinkwrap.descriptor.api.Child<T>

All Known Implementing Classes:
  FilterTypeImpl

    public interface FilterType<T>

extends org.jboss.shrinkwrap.descriptor.api.Child<T>

This interface defines the contract for the `filterType` xsd type

Original Documentation:

The filterType is used to declare a filter in the web
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.
Used in: web-app

Since:
  Generation date :2011-07-19T22:55:02.759+02:00
Author:
  Ralf Battenfeld

Method Summary
`java.util.List<java.lang.String>` | `getDescriptionList()` Returns all `description` elements
`java.util.List<java.lang.String>` | `getDisplayNameList()` Returns all `display-name` elements
`java.lang.String` | `getFilterClass()` Returns the `filter-class` element
`java.lang.String` | `getFilterName()` Returns the `filter-name` element
`java.util.List<IconType<FilterType<T>>>` | `getIconList()` Returns all `icon` elements
`java.util.List<ParamValueType<FilterType<T>>>` | `getInitParamList()` Returns all `init-param` elements
`IconType<FilterType<T>>` | `icon()` Returns the `icon` element
`ParamValueType<FilterType<T>>` | `initParam()` Returns the `init-param` element
`java.lang.Boolean` | `isAsyncSupported()` Returns the `async-supported` element
`FilterType<T>` | `removeAllDescription()` Removes the `description` element
`FilterType<T>` | `removeAllDisplayName()` Removes the `display-name` element
`FilterType<T>` | `removeAllIcon()` Removes all `icon` elements
`FilterType<T>` | `removeAllInitParam()` Removes all `init-param` elements
`FilterType<T>` | `removeAsyncSupported()` Removes the `async-supported` element
`FilterType<T>` | `removeFilterClass()` Removes the `filter-class` element
`FilterType<T>` | `removeFilterName()` Removes the `filter-name` element
`FilterType<T>` | `setAsyncSupported(java.lang.Boolean asyncSupported)` If not already created, a new `async-supported` element with the given value will be created.
`FilterType<T>` | `setDescription(java.lang.String description)` Creates a new `description` element
`FilterType<T>` | `setDescriptionList(java.lang.String... values)` Creates for all String objects representing `description` elements, a new `description` element
`FilterType<T>` | `setDisplayName(java.lang.String displayName)` Creates a new `display-name` element
`FilterType<T>` | `setDisplayNameList(java.lang.String... values)` Creates for all String objects representing `display-name` elements, a new `display-name` element
`FilterType<T>` | `setFilterClass(java.lang.String filterClass)` If not already created, a new `filter-class` element with the given value will be created.
`FilterType<T>` | `setFilterName(java.lang.String filterName)` If not already created, a new `filter-name` element with the given value will be created.

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child
`up`

Method Detail

### setDescription

    FilterType<T> setDescription(java.lang.String description)

  Creates a new `description` element

  Returns:
    the current instance of `FilterType`

### setDescriptionList

    FilterType<T> setDescriptionList(java.lang.String... values)

  Creates for all String objects representing `description` elements, a new `description` element

  Parameters:
    `list` - of `description` objects
  Returns:
    the current instance of `FilterType`

### removeAllDescription

    FilterType<T> removeAllDescription()

  Removes the `description` element

  Returns:
    the current instance of `FilterType`

### getDescriptionList

    java.util.List<java.lang.String> getDescriptionList()

  Returns all `description` elements

  Returns:
    list of `description`

### setDisplayName

    FilterType<T> setDisplayName(java.lang.String displayName)

  Creates a new `display-name` element

  Returns:
    the current instance of `FilterType`

### setDisplayNameList

    FilterType<T> setDisplayNameList(java.lang.String... values)

  Creates for all String objects representing `display-name` elements, a new `display-name` element

  Parameters:
    `list` - of `display-name` objects
  Returns:
    the current instance of `FilterType`

### removeAllDisplayName

    FilterType<T> removeAllDisplayName()

  Removes the `display-name` element

  Returns:
    the current instance of `FilterType`

### getDisplayNameList

    java.util.List<java.lang.String> getDisplayNameList()

  Returns all `display-name` elements

  Returns:
    list of `display-name`

### removeAllIcon

    FilterType<T> removeAllIcon()

  Removes all `icon` elements

  Returns:
    the current instance of `FilterType`

### icon

    IconType<FilterType<T>> icon()

  Returns the `icon` element

  Returns:
    the node defined for the element `icon`

### getIconList

    java.util.List<IconType<FilterType<T>>> getIconList()

  Returns all `icon` elements

  Returns:
    list of `icon`

### setFilterName

    FilterType<T> setFilterName(java.lang.String filterName)

  If not already created, a new `filter-name` element with the given value will be created. Otherwise, the existing `filter-name` element will be updated with the given value.

  Returns:
    the current instance of `FilterType`

### removeFilterName

    FilterType<T> removeFilterName()

  Removes the `filter-name` element

  Returns:
    the current instance of `FilterType`

### getFilterName

    java.lang.String getFilterName()

  Returns the `filter-name` element

  Returns:
    the node defined for the element `filter-name`

### setFilterClass

    FilterType<T> setFilterClass(java.lang.String filterClass)

  If not already created, a new `filter-class` element with the given value will be created. Otherwise, the existing `filter-class` element will be updated with the given value.

  Returns:
    the current instance of `FilterType`

### removeFilterClass

    FilterType<T> removeFilterClass()

  Removes the `filter-class` element

  Returns:
    the current instance of `FilterType`

### getFilterClass

    java.lang.String getFilterClass()

  Returns the `filter-class` element

  Returns:
    the node defined for the element `filter-class`

### setAsyncSupported

    FilterType<T> setAsyncSupported(java.lang.Boolean asyncSupported)

  If not already created, a new `async-supported` element with the given value will be created. Otherwise, the existing `async-supported` element will be updated with the given value.

  Returns:
    the current instance of `FilterType`

### removeAsyncSupported

    FilterType<T> removeAsyncSupported()

  Removes the `async-supported` element

  Returns:
    the current instance of `FilterType`

### isAsyncSupported

    java.lang.Boolean isAsyncSupported()

  Returns the `async-supported` element

  Returns:
    the node defined for the element `async-supported`

### removeAllInitParam

    FilterType<T> removeAllInitParam()

  Removes all `init-param` elements

  Returns:
    the current instance of `FilterType`

### initParam

    ParamValueType<FilterType<T>> initParam()

  Returns the `init-param` element

  Returns:
    the node defined for the element `init-param`

### getInitParamList

    java.util.List<ParamValueType<FilterType<T>>> getInitParamList()

  Returns all `init-param` elements

  Returns:
    list of `init-param`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD