org.jboss.shrinkwrap.descriptor.api.webapp30

Interface WebAppMutableDescriptor

All Superinterfaces:

Descriptor, Mutable<WebAppDescriptor,WebAppMutableDescriptor>, WebAppDescriptorBase<FilterMutableType,WebAppMutableDescriptor>

public interface WebAppMutableDescriptor
extends WebAppDescriptorBase<FilterMutableType,WebAppMutableDescriptor>, Mutable<WebAppDescriptor,WebAppMutableDescriptor>

Mutable view of a web application deployment descriptor (ie. web.xml).

Author:

Andrew Lee Rubinger

Method Summary

Modifier and Type	Method and Description
FilterMutableType	createFilter() Creates a new filter element
FilterMutableType	getOrCreateFilter() If not already created, a new filter element will be created and returned.
WebAppMutableDescriptor	removeAllFilter() Removes all filter elements

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.webapp30.WebAppDescriptorBase

getAllFilter

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

exportAsString, exportTo, getDescriptorName

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

toImmutable

Method Detail

getOrCreateFilter

FilterMutableType getOrCreateFilter()

If not already created, a new filter element will be created and returned. Otherwise, the first existing filter element will be returned.

Returns:

the instance defined for the element filter

createFilter

FilterMutableType createFilter()

Creates a new filter element

Returns:

the new created instance of FilterType

removeAllFilter

WebAppMutableDescriptor removeAllFilter()

Removes all filter elements

Returns:

the current instance of FilterType