org.jboss.shrinkwrap.descriptor.api.portletapp20
Interface FilterType<T>

All Superinterfaces:

Child<T>

public interface FilterType<T>
extends Child<T>

This interface defines the contract for the filterType xsd type

Since:

Generation date :2012-05-09T23:45:02.086-07:00

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

InitParamType<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<InitParamType<FilterType<T>>>	getAllInitParam() Returns all init-param elements
List<String>	getAllLifecycle() Returns all lifecycle elements
String	getFilterClass() Returns the filter-class element
String	getFilterName() Returns the filter-name element
InitParamType<FilterType<T>>	getOrCreateInitParam() If not already created, a new init-param element will be created and returned.
FilterType<T>	lifecycle(String... values) Creates for all String objects representing lifecycle elements, a new lifecycle element
FilterType<T>	removeAllDescription() Removes the description element
FilterType<T>	removeAllDisplayName() Removes the display-name element
FilterType<T>	removeAllInitParam() Removes all init-param elements
FilterType<T>	removeAllLifecycle() Removes the lifecycle element
FilterType<T>	removeFilterClass() Removes the filter-class element
FilterType<T>	removeFilterName() Removes the filter-name element

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

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

lifecycle

FilterType<T> lifecycle(String... values)

Creates for all String objects representing lifecycle elements, a new lifecycle element

Parameters:

values - list of lifecycle objects

Returns:

the current instance of FilterType

getAllLifecycle

List<String> getAllLifecycle()

Returns all lifecycle elements

Returns:

list of lifecycle

removeAllLifecycle

FilterType<T> removeAllLifecycle()

Removes the lifecycle element

Returns:

the current instance of FilterType

getOrCreateInitParam

InitParamType<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

InitParamType<FilterType<T>> createInitParam()

Creates a new init-param element

Returns:

the new created instance of InitParamType>

getAllInitParam

List<InitParamType<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 InitParamType>