org.jboss.shrinkwrap.descriptor.api.webcommon30

Interface FilterMutableType

All Superinterfaces:

Child<WebAppMutableDescriptor>, FilterTypeBase<FilterMutableType,WebAppMutableDescriptor>

public interface FilterMutableType
extends FilterTypeBase<FilterMutableType,WebAppMutableDescriptor>

End-user view of a "web-app/filter" element which is mutable.

Author:

Andrew Lee Rubinger

Method Summary

Modifier and Type	Method and Description
FilterMutableType	description(String... values) Creates for all String objects representing description elements, a new description element
FilterMutableType	removeAllDescription() Removes the description element
FilterMutableType	removeDescription(String value) Removes the description element with the specified value.

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.webcommon30.FilterTypeBase

getAllDescription

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

up

Method Detail

removeDescription

FilterMutableType removeDescription(String value)
                             throws IllegalArgumentException

Removes the description element with the specified value. If the specified value is not a current description, this call will be a no-op.

Parameters:

value -

Returns:

This instance

Throws:

IllegalArgumentException - If the value is not specified

removeAllDescription

FilterMutableType removeAllDescription()

Removes the description element

Returns:

the current instance of FilterType

description

FilterMutableType description(String... values)
                       throws IllegalArgumentException

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

Parameters:

values - list of description objects

Returns:

the current instance of FilterType

Throws:

IllegalArgumentException - If no values are specified or if any specified value is blank or null