|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FilterType<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
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 |
---|
FilterType<T> setDescription(java.lang.String description)
description
element
FilterType
FilterType<T> setDescriptionList(java.lang.String... values)
description
elements,
a new description
element
list
- of description
objects
FilterType
FilterType<T> removeAllDescription()
description
element
FilterType
java.util.List<java.lang.String> getDescriptionList()
description
elements
description
FilterType<T> setDisplayName(java.lang.String displayName)
display-name
element
FilterType
FilterType<T> setDisplayNameList(java.lang.String... values)
display-name
elements,
a new display-name
element
list
- of display-name
objects
FilterType
FilterType<T> removeAllDisplayName()
display-name
element
FilterType
java.util.List<java.lang.String> getDisplayNameList()
display-name
elements
display-name
FilterType<T> removeAllIcon()
icon
elements
FilterType
IconType<FilterType<T>> icon()
icon
element
icon
java.util.List<IconType<FilterType<T>>> getIconList()
icon
elements
icon
FilterType<T> setFilterName(java.lang.String filterName)
filter-name
element with the given value will be created.
Otherwise, the existing filter-name
element will be updated with the given value.
FilterType
FilterType<T> removeFilterName()
filter-name
element
FilterType
java.lang.String getFilterName()
filter-name
element
filter-name
FilterType<T> setFilterClass(java.lang.String filterClass)
filter-class
element with the given value will be created.
Otherwise, the existing filter-class
element will be updated with the given value.
FilterType
FilterType<T> removeFilterClass()
filter-class
element
FilterType
java.lang.String getFilterClass()
filter-class
element
filter-class
FilterType<T> setAsyncSupported(java.lang.Boolean asyncSupported)
async-supported
element with the given value will be created.
Otherwise, the existing async-supported
element will be updated with the given value.
FilterType
FilterType<T> removeAsyncSupported()
async-supported
element
FilterType
java.lang.Boolean isAsyncSupported()
async-supported
element
async-supported
FilterType<T> removeAllInitParam()
init-param
elements
FilterType
ParamValueType<FilterType<T>> initParam()
init-param
element
init-param
java.util.List<ParamValueType<FilterType<T>>> getInitParamList()
init-param
elements
init-param
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |