FilterType (ShrinkWrap Descriptors Aggregator 2.0.0-alpha-9 API)

All Superinterfaces:

Child<T>, JavaeeFilterCommonType<T,FilterType<T>,ParamValueType<FilterType<T>>>
```
public interface FilterType<T>
extends Child<T>, JavaeeFilterCommonType<T,FilterType<T>,ParamValueType<FilterType<T>>>
```
This interface defines the contract for the filterType xsd type

Author:

Ralf Battenfeld, Andrew Lee Rubinger, George Gastaldi

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`IconType<FilterType<T>>`	`createIcon()` Creates a new `icon` element
`ParamValueType<FilterType<T>>`	`createInitParam()` Creates a new `init-param` element
`FilterType<T>`	`description(String... values)` Creates for all String objects representing `description` elements, a new `description` element
`FilterType<T>`	`displayName(String... values)` Creates for all String objects representing `display-name` elements, a new `display-name` element
`FilterType<T>`	`filterClass(String filterClass)` Sets the `filter-class` element
`FilterType<T>`	`filterName(String filterName)` Sets the `filter-name` element
`List<String>`	`getAllDescription()` Returns all `description` elements
`List<String>`	`getAllDisplayName()` Returns all `display-name` elements
`List<IconType<FilterType<T>>>`	`getAllIcon()` Returns all `icon` elements
`List<ParamValueType<FilterType<T>>>`	`getAllInitParam()` Returns all `init-param` elements
`String`	`getFilterClass()` Returns the `filter-class` element
`String`	`getFilterName()` Returns the `filter-name` element
`String`	`getId()` Returns the `id` attribute
`IconType<FilterType<T>>`	`getOrCreateIcon()` If not already created, a new `icon` element will be created and returned.
`ParamValueType<FilterType<T>>`	`getOrCreateInitParam()` If not already created, a new `init-param` element will be created and returned.
`FilterType<T>`	`id(String id)` Sets the `id` attribute
`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>`	`removeFilterClass()` Removes the `filter-class` element
`FilterType<T>`	`removeFilterName()` Removes the `filter-name` element
`FilterType<T>`	`removeId()` Removes the `id` attribute

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

- Method Detail
  - description
```
FilterType<T> description(String... values)
```
    Creates for all String objects representing description elements, a new description element
    
    Parameters:
    
    values - list of description objects
    
    Returns:
    
    the current instance of FilterType
  - getAllDescription
```
List<String> getAllDescription()
```
    Returns all description elements
    
    Returns:
    
    list of description
  - removeAllDescription
```
FilterType<T> removeAllDescription()
```
    Removes the description element
    
    Returns:
    
    the current instance of FilterType
  - displayName
```
FilterType<T> displayName(String... values)
```
    Creates for all String objects representing display-name elements, a new display-name element
    
    Parameters:
    
    values - list of display-name objects
    
    Returns:
    
    the current instance of FilterType
  - getAllDisplayName
```
List<String> getAllDisplayName()
```
    Returns all display-name elements
    
    Returns:
    
    list of display-name
  - removeAllDisplayName
```
FilterType<T> removeAllDisplayName()
```
    Removes the display-name element
    
    Returns:
    
    the current instance of FilterType
  - getOrCreateIcon
```
IconType<FilterType<T>> getOrCreateIcon()
```
    If not already created, a new icon element will be created and returned. Otherwise, the first existing icon element will be returned.
    
    Returns:
    
    the instance defined for the element icon
  - createIcon
```
IconType<FilterType<T>> createIcon()
```
    Creates a new icon element
    
    Returns:
    
    the new created instance of IconType>
  - getAllIcon
```
List<IconType<FilterType<T>>> getAllIcon()
```
    Returns all icon elements
    
    Returns:
    
    list of icon
  - removeAllIcon
```
FilterType<T> removeAllIcon()
```
    Removes all icon elements
    
    Returns:
    
    the current instance of IconType>
  - filterName
```
FilterType<T> filterName(String filterName)
```
    Sets the filter-name element
    
    Parameters:
    
    filterName - the value for the element filter-name
    
    Returns:
    
    the current instance of FilterType
  - getFilterName
```
String getFilterName()
```
    Returns the filter-name element
    
    Returns:
    
    the node defined for the element filter-name
  - removeFilterName
```
FilterType<T> removeFilterName()
```
    Removes the filter-name element
    
    Returns:
    
    the current instance of FilterType
  - filterClass
```
FilterType<T> filterClass(String filterClass)
```
    Sets the filter-class element
    
    Parameters:
    
    filterClass - the value for the element filter-class
    
    Returns:
    
    the current instance of FilterType
  - getFilterClass
```
String getFilterClass()
```
    Returns the filter-class element
    
    Returns:
    
    the node defined for the element filter-class
  - removeFilterClass
```
FilterType<T> removeFilterClass()
```
    Removes the filter-class element
    
    Returns:
    
    the current instance of FilterType
  - getOrCreateInitParam
```
ParamValueType<FilterType<T>> getOrCreateInitParam()
```
    If not already created, a new init-param element will be created and returned. Otherwise, the first existing init-param element will be returned.
    
    Returns:
    
    the instance defined for the element init-param
  - createInitParam
```
ParamValueType<FilterType<T>> createInitParam()
```
    Creates a new init-param element
    
    Returns:
    
    the new created instance of ParamValueType>
  - getAllInitParam
```
List<ParamValueType<FilterType<T>>> getAllInitParam()
```
    Returns all init-param elements
    
    Returns:
    
    list of init-param
  - removeAllInitParam
```
FilterType<T> removeAllInitParam()
```
    Removes all init-param elements
    
    Returns:
    
    the current instance of ParamValueType>
  - id
```
FilterType<T> id(String id)
```
    Sets the id attribute
    
    Parameters:
    
    id - the value for the attribute id
    
    Returns:
    
    the current instance of FilterType
  - getId
```
String getId()
```
    Returns the id attribute
    
    Returns:
    
    the value defined for the attribute id
  - removeId
```
FilterType<T> removeId()
```
    Removes the id attribute
    
    Returns:
    
    the current instance of FilterType

Interface FilterType<T>

Method Summary

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

Method Detail

description

getAllDescription

removeAllDescription

displayName

getAllDisplayName

removeAllDisplayName

getOrCreateIcon

createIcon

getAllIcon

removeAllIcon

filterName

getFilterName

removeFilterName

filterClass

getFilterClass

removeFilterClass

getOrCreateInitParam

createInitParam

getAllInitParam

removeAllInitParam

id

getId

removeId