ShrinkWrap Descriptors Generated Java EE API 2.0.0-alpha-3

org.jboss.shrinkwrap.descriptor.api.webapp30
Interface WebAppDescriptor

All Superinterfaces:
Descriptor, DescriptorNamespace<WebAppDescriptor>

public interface WebAppDescriptor
extends Descriptor, DescriptorNamespace<WebAppDescriptor>

This deployment descriptor provides the functionalities as described in the specification

Example:

WebAppDescriptor descriptor = Descriptors.create(WebAppDescriptor.class);

Since:
Generation date :2012-05-09T23:45:05.33-07:00
Author:
Ralf Battenfeld, Andrew Lee Rubinger

Method Summary
 AbsoluteOrderingType<WebAppDescriptor> createAbsoluteOrdering()
          Creates a new absolute-ordering element
 ParamValueType<WebAppDescriptor> createContextParam()
          Creates a new context-param element
 DataSourceType<WebAppDescriptor> createDataSource()
          Creates a new data-source element
 EjbLocalRefType<WebAppDescriptor> createEjbLocalRef()
          Creates a new ejb-local-ref element
 EjbRefType<WebAppDescriptor> createEjbRef()
          Creates a new ejb-ref element
 EnvEntryType<WebAppDescriptor> createEnvEntry()
          Creates a new env-entry element
 ErrorPageType<WebAppDescriptor> createErrorPage()
          Creates a new error-page element
 FilterType<WebAppDescriptor> createFilter()
          Creates a new filter element
 FilterMappingType<WebAppDescriptor> createFilterMapping()
          Creates a new filter-mapping element
 IconType<WebAppDescriptor> createIcon()
          Creates a new icon element
 JspConfigType<WebAppDescriptor> createJspConfig()
          Creates a new jsp-config element
 ListenerType<WebAppDescriptor> createListener()
          Creates a new listener element
 LocaleEncodingMappingListType<WebAppDescriptor> createLocaleEncodingMappingList()
          Creates a new locale-encoding-mapping-list element
 LoginConfigType<WebAppDescriptor> createLoginConfig()
          Creates a new login-config element
 MessageDestinationType<WebAppDescriptor> createMessageDestination()
          Creates a new message-destination element
 MessageDestinationRefType<WebAppDescriptor> createMessageDestinationRef()
          Creates a new message-destination-ref element
 MimeMappingType<WebAppDescriptor> createMimeMapping()
          Creates a new mime-mapping element
 PersistenceContextRefType<WebAppDescriptor> createPersistenceContextRef()
          Creates a new persistence-context-ref element
 PersistenceUnitRefType<WebAppDescriptor> createPersistenceUnitRef()
          Creates a new persistence-unit-ref element
 LifecycleCallbackType<WebAppDescriptor> createPostConstruct()
          Creates a new post-construct element
 LifecycleCallbackType<WebAppDescriptor> createPreDestroy()
          Creates a new pre-destroy element
 ResourceEnvRefType<WebAppDescriptor> createResourceEnvRef()
          Creates a new resource-env-ref element
 ResourceRefType<WebAppDescriptor> createResourceRef()
          Creates a new resource-ref element
 SecurityConstraintType<WebAppDescriptor> createSecurityConstraint()
          Creates a new security-constraint element
 SecurityRoleType<WebAppDescriptor> createSecurityRole()
          Creates a new security-role element
 ServiceRefType<WebAppDescriptor> createServiceRef()
          Creates a new service-ref element
 ServletType<WebAppDescriptor> createServlet()
          Creates a new servlet element
 ServletMappingType<WebAppDescriptor> createServletMapping()
          Creates a new servlet-mapping element
 SessionConfigType<WebAppDescriptor> createSessionConfig()
          Creates a new session-config element
 WelcomeFileListType<WebAppDescriptor> createWelcomeFileList()
          Creates a new welcome-file-list element
 WebAppDescriptor description(String... values)
          Creates for all String objects representing description elements, a new description element
 WebAppDescriptor displayName(String... values)
          Creates for all String objects representing display-name elements, a new display-name element
 WebAppDescriptor distributable()
          Sets the distributable element
 List<AbsoluteOrderingType<WebAppDescriptor>> getAllAbsoluteOrdering()
          Returns all absolute-ordering elements
 List<ParamValueType<WebAppDescriptor>> getAllContextParam()
          Returns all context-param elements
 List<DataSourceType<WebAppDescriptor>> getAllDataSource()
          Returns all data-source elements
 List<String> getAllDescription()
          Returns all description elements
 List<String> getAllDisplayName()
          Returns all display-name elements
 List<EjbLocalRefType<WebAppDescriptor>> getAllEjbLocalRef()
          Returns all ejb-local-ref elements
 List<EjbRefType<WebAppDescriptor>> getAllEjbRef()
          Returns all ejb-ref elements
 List<EnvEntryType<WebAppDescriptor>> getAllEnvEntry()
          Returns all env-entry elements
 List<ErrorPageType<WebAppDescriptor>> getAllErrorPage()
          Returns all error-page elements
 List<FilterType<WebAppDescriptor>> getAllFilter()
          Returns all filter elements
 List<FilterMappingType<WebAppDescriptor>> getAllFilterMapping()
          Returns all filter-mapping elements
 List<IconType<WebAppDescriptor>> getAllIcon()
          Returns all icon elements
 List<JspConfigType<WebAppDescriptor>> getAllJspConfig()
          Returns all jsp-config elements
 List<ListenerType<WebAppDescriptor>> getAllListener()
          Returns all listener elements
 List<LocaleEncodingMappingListType<WebAppDescriptor>> getAllLocaleEncodingMappingList()
          Returns all locale-encoding-mapping-list elements
 List<LoginConfigType<WebAppDescriptor>> getAllLoginConfig()
          Returns all login-config elements
 List<MessageDestinationType<WebAppDescriptor>> getAllMessageDestination()
          Returns all message-destination elements
 List<MessageDestinationRefType<WebAppDescriptor>> getAllMessageDestinationRef()
          Returns all message-destination-ref elements
 List<MimeMappingType<WebAppDescriptor>> getAllMimeMapping()
          Returns all mime-mapping elements
 List<String> getAllModuleName()
          Returns all module-name elements
 List<PersistenceContextRefType<WebAppDescriptor>> getAllPersistenceContextRef()
          Returns all persistence-context-ref elements
 List<PersistenceUnitRefType<WebAppDescriptor>> getAllPersistenceUnitRef()
          Returns all persistence-unit-ref elements
 List<LifecycleCallbackType<WebAppDescriptor>> getAllPostConstruct()
          Returns all post-construct elements
 List<LifecycleCallbackType<WebAppDescriptor>> getAllPreDestroy()
          Returns all pre-destroy elements
 List<ResourceEnvRefType<WebAppDescriptor>> getAllResourceEnvRef()
          Returns all resource-env-ref elements
 List<ResourceRefType<WebAppDescriptor>> getAllResourceRef()
          Returns all resource-ref elements
 List<SecurityConstraintType<WebAppDescriptor>> getAllSecurityConstraint()
          Returns all security-constraint elements
 List<SecurityRoleType<WebAppDescriptor>> getAllSecurityRole()
          Returns all security-role elements
 List<ServiceRefType<WebAppDescriptor>> getAllServiceRef()
          Returns all service-ref elements
 List<ServletType<WebAppDescriptor>> getAllServlet()
          Returns all servlet elements
 List<ServletMappingType<WebAppDescriptor>> getAllServletMapping()
          Returns all servlet-mapping elements
 List<SessionConfigType<WebAppDescriptor>> getAllSessionConfig()
          Returns all session-config elements
 List<WelcomeFileListType<WebAppDescriptor>> getAllWelcomeFileList()
          Returns all welcome-file-list elements
 String getId()
          Returns the id attribute
 AbsoluteOrderingType<WebAppDescriptor> getOrCreateAbsoluteOrdering()
          If not already created, a new absolute-ordering element will be created and returned.
 ParamValueType<WebAppDescriptor> getOrCreateContextParam()
          If not already created, a new context-param element will be created and returned.
 DataSourceType<WebAppDescriptor> getOrCreateDataSource()
          If not already created, a new data-source element will be created and returned.
 EjbLocalRefType<WebAppDescriptor> getOrCreateEjbLocalRef()
          If not already created, a new ejb-local-ref element will be created and returned.
 EjbRefType<WebAppDescriptor> getOrCreateEjbRef()
          If not already created, a new ejb-ref element will be created and returned.
 EnvEntryType<WebAppDescriptor> getOrCreateEnvEntry()
          If not already created, a new env-entry element will be created and returned.
 ErrorPageType<WebAppDescriptor> getOrCreateErrorPage()
          If not already created, a new error-page element will be created and returned.
 FilterType<WebAppDescriptor> getOrCreateFilter()
          If not already created, a new filter element will be created and returned.
 FilterMappingType<WebAppDescriptor> getOrCreateFilterMapping()
          If not already created, a new filter-mapping element will be created and returned.
 IconType<WebAppDescriptor> getOrCreateIcon()
          If not already created, a new icon element will be created and returned.
 JspConfigType<WebAppDescriptor> getOrCreateJspConfig()
          If not already created, a new jsp-config element will be created and returned.
 ListenerType<WebAppDescriptor> getOrCreateListener()
          If not already created, a new listener element will be created and returned.
 LocaleEncodingMappingListType<WebAppDescriptor> getOrCreateLocaleEncodingMappingList()
          If not already created, a new locale-encoding-mapping-list element will be created and returned.
 LoginConfigType<WebAppDescriptor> getOrCreateLoginConfig()
          If not already created, a new login-config element will be created and returned.
 MessageDestinationType<WebAppDescriptor> getOrCreateMessageDestination()
          If not already created, a new message-destination element will be created and returned.
 MessageDestinationRefType<WebAppDescriptor> getOrCreateMessageDestinationRef()
          If not already created, a new message-destination-ref element will be created and returned.
 MimeMappingType<WebAppDescriptor> getOrCreateMimeMapping()
          If not already created, a new mime-mapping element will be created and returned.
 PersistenceContextRefType<WebAppDescriptor> getOrCreatePersistenceContextRef()
          If not already created, a new persistence-context-ref element will be created and returned.
 PersistenceUnitRefType<WebAppDescriptor> getOrCreatePersistenceUnitRef()
          If not already created, a new persistence-unit-ref element will be created and returned.
 LifecycleCallbackType<WebAppDescriptor> getOrCreatePostConstruct()
          If not already created, a new post-construct element will be created and returned.
 LifecycleCallbackType<WebAppDescriptor> getOrCreatePreDestroy()
          If not already created, a new pre-destroy element will be created and returned.
 ResourceEnvRefType<WebAppDescriptor> getOrCreateResourceEnvRef()
          If not already created, a new resource-env-ref element will be created and returned.
 ResourceRefType<WebAppDescriptor> getOrCreateResourceRef()
          If not already created, a new resource-ref element will be created and returned.
 SecurityConstraintType<WebAppDescriptor> getOrCreateSecurityConstraint()
          If not already created, a new security-constraint element will be created and returned.
 SecurityRoleType<WebAppDescriptor> getOrCreateSecurityRole()
          If not already created, a new security-role element will be created and returned.
 ServiceRefType<WebAppDescriptor> getOrCreateServiceRef()
          If not already created, a new service-ref element will be created and returned.
 ServletType<WebAppDescriptor> getOrCreateServlet()
          If not already created, a new servlet element will be created and returned.
 ServletMappingType<WebAppDescriptor> getOrCreateServletMapping()
          If not already created, a new servlet-mapping element will be created and returned.
 SessionConfigType<WebAppDescriptor> getOrCreateSessionConfig()
          If not already created, a new session-config element will be created and returned.
 WelcomeFileListType<WebAppDescriptor> getOrCreateWelcomeFileList()
          If not already created, a new welcome-file-list element will be created and returned.
 WebAppVersionType getVersion()
          Returns the version attribute
 String getVersionAsString()
          Returns the version attribute
 WebAppDescriptor id(String id)
          Sets the id attribute
 Boolean isDistributable()
          Removes the distributable element
 Boolean isMetadataComplete()
          Returns the metadata-complete attribute
 WebAppDescriptor metadataComplete(Boolean metadataComplete)
          Sets the metadata-complete attribute
 WebAppDescriptor moduleName(String... values)
          Creates for all String objects representing module-name elements, a new module-name element
 WebAppDescriptor removeAllAbsoluteOrdering()
          Removes all absolute-ordering elements
 WebAppDescriptor removeAllContextParam()
          Removes all context-param elements
 WebAppDescriptor removeAllDataSource()
          Removes all data-source elements
 WebAppDescriptor removeAllDescription()
          Removes the description element
 WebAppDescriptor removeAllDisplayName()
          Removes the display-name element
 WebAppDescriptor removeAllEjbLocalRef()
          Removes all ejb-local-ref elements
 WebAppDescriptor removeAllEjbRef()
          Removes all ejb-ref elements
 WebAppDescriptor removeAllEnvEntry()
          Removes all env-entry elements
 WebAppDescriptor removeAllErrorPage()
          Removes all error-page elements
 WebAppDescriptor removeAllFilter()
          Removes all filter elements
 WebAppDescriptor removeAllFilterMapping()
          Removes all filter-mapping elements
 WebAppDescriptor removeAllIcon()
          Removes all icon elements
 WebAppDescriptor removeAllJspConfig()
          Removes all jsp-config elements
 WebAppDescriptor removeAllListener()
          Removes all listener elements
 WebAppDescriptor removeAllLocaleEncodingMappingList()
          Removes all locale-encoding-mapping-list elements
 WebAppDescriptor removeAllLoginConfig()
          Removes all login-config elements
 WebAppDescriptor removeAllMessageDestination()
          Removes all message-destination elements
 WebAppDescriptor removeAllMessageDestinationRef()
          Removes all message-destination-ref elements
 WebAppDescriptor removeAllMimeMapping()
          Removes all mime-mapping elements
 WebAppDescriptor removeAllModuleName()
          Removes the module-name element
 WebAppDescriptor removeAllPersistenceContextRef()
          Removes all persistence-context-ref elements
 WebAppDescriptor removeAllPersistenceUnitRef()
          Removes all persistence-unit-ref elements
 WebAppDescriptor removeAllPostConstruct()
          Removes all post-construct elements
 WebAppDescriptor removeAllPreDestroy()
          Removes all pre-destroy elements
 WebAppDescriptor removeAllResourceEnvRef()
          Removes all resource-env-ref elements
 WebAppDescriptor removeAllResourceRef()
          Removes all resource-ref elements
 WebAppDescriptor removeAllSecurityConstraint()
          Removes all security-constraint elements
 WebAppDescriptor removeAllSecurityRole()
          Removes all security-role elements
 WebAppDescriptor removeAllServiceRef()
          Removes all service-ref elements
 WebAppDescriptor removeAllServlet()
          Removes all servlet elements
 WebAppDescriptor removeAllServletMapping()
          Removes all servlet-mapping elements
 WebAppDescriptor removeAllSessionConfig()
          Removes all session-config elements
 WebAppDescriptor removeAllWelcomeFileList()
          Removes all welcome-file-list elements
 WebAppDescriptor removeDistributable()
          Removes the distributable element
 WebAppDescriptor removeId()
          Removes the id attribute
 WebAppDescriptor removeMetadataComplete()
          Removes the metadata-complete attribute
 WebAppDescriptor removeVersion()
          Removes the version attribute
 WebAppDescriptor version(String version)
          Sets the version attribute
 WebAppDescriptor version(WebAppVersionType version)
          Sets the version attribute
 
Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Descriptor
exportAsString, exportTo, getDescriptorName
 
Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace
addDefaultNamespaces, addNamespace, getNamespaces, removeAllNamespaces
 

Method Detail

distributable

WebAppDescriptor distributable()
Sets the distributable element

Returns:
the current instance of WebAppDescriptor

isDistributable

Boolean isDistributable()
Removes the distributable element

Returns:
the current instance of WebAppDescriptor

removeDistributable

WebAppDescriptor removeDistributable()
Removes the distributable element

Returns:
the current instance of WebAppDescriptor

getOrCreateContextParam

ParamValueType<WebAppDescriptor> getOrCreateContextParam()
If not already created, a new context-param element will be created and returned. Otherwise, the first existing context-param element will be returned.

Returns:
the instance defined for the element context-param

createContextParam

ParamValueType<WebAppDescriptor> createContextParam()
Creates a new context-param element

Returns:
the new created instance of ParamValueType

getAllContextParam

List<ParamValueType<WebAppDescriptor>> getAllContextParam()
Returns all context-param elements

Returns:
list of context-param

removeAllContextParam

WebAppDescriptor removeAllContextParam()
Removes all context-param elements

Returns:
the current instance of ParamValueType

getOrCreateFilter

FilterType<WebAppDescriptor> 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

FilterType<WebAppDescriptor> createFilter()
Creates a new filter element

Returns:
the new created instance of FilterType

getAllFilter

List<FilterType<WebAppDescriptor>> getAllFilter()
Returns all filter elements

Returns:
list of filter

removeAllFilter

WebAppDescriptor removeAllFilter()
Removes all filter elements

Returns:
the current instance of FilterType

getOrCreateFilterMapping

FilterMappingType<WebAppDescriptor> getOrCreateFilterMapping()
If not already created, a new filter-mapping element will be created and returned. Otherwise, the first existing filter-mapping element will be returned.

Returns:
the instance defined for the element filter-mapping

createFilterMapping

FilterMappingType<WebAppDescriptor> createFilterMapping()
Creates a new filter-mapping element

Returns:
the new created instance of FilterMappingType

getAllFilterMapping

List<FilterMappingType<WebAppDescriptor>> getAllFilterMapping()
Returns all filter-mapping elements

Returns:
list of filter-mapping

removeAllFilterMapping

WebAppDescriptor removeAllFilterMapping()
Removes all filter-mapping elements

Returns:
the current instance of FilterMappingType

getOrCreateListener

ListenerType<WebAppDescriptor> getOrCreateListener()
If not already created, a new listener element will be created and returned. Otherwise, the first existing listener element will be returned.

Returns:
the instance defined for the element listener

createListener

ListenerType<WebAppDescriptor> createListener()
Creates a new listener element

Returns:
the new created instance of ListenerType

getAllListener

List<ListenerType<WebAppDescriptor>> getAllListener()
Returns all listener elements

Returns:
list of listener

removeAllListener

WebAppDescriptor removeAllListener()
Removes all listener elements

Returns:
the current instance of ListenerType

getOrCreateServlet

ServletType<WebAppDescriptor> getOrCreateServlet()
If not already created, a new servlet element will be created and returned. Otherwise, the first existing servlet element will be returned.

Returns:
the instance defined for the element servlet

createServlet

ServletType<WebAppDescriptor> createServlet()
Creates a new servlet element

Returns:
the new created instance of ServletType

getAllServlet

List<ServletType<WebAppDescriptor>> getAllServlet()
Returns all servlet elements

Returns:
list of servlet

removeAllServlet

WebAppDescriptor removeAllServlet()
Removes all servlet elements

Returns:
the current instance of ServletType

getOrCreateServletMapping

ServletMappingType<WebAppDescriptor> getOrCreateServletMapping()
If not already created, a new servlet-mapping element will be created and returned. Otherwise, the first existing servlet-mapping element will be returned.

Returns:
the instance defined for the element servlet-mapping

createServletMapping

ServletMappingType<WebAppDescriptor> createServletMapping()
Creates a new servlet-mapping element

Returns:
the new created instance of ServletMappingType

getAllServletMapping

List<ServletMappingType<WebAppDescriptor>> getAllServletMapping()
Returns all servlet-mapping elements

Returns:
list of servlet-mapping

removeAllServletMapping

WebAppDescriptor removeAllServletMapping()
Removes all servlet-mapping elements

Returns:
the current instance of ServletMappingType

getOrCreateSessionConfig

SessionConfigType<WebAppDescriptor> getOrCreateSessionConfig()
If not already created, a new session-config element will be created and returned. Otherwise, the first existing session-config element will be returned.

Returns:
the instance defined for the element session-config

createSessionConfig

SessionConfigType<WebAppDescriptor> createSessionConfig()
Creates a new session-config element

Returns:
the new created instance of SessionConfigType

getAllSessionConfig

List<SessionConfigType<WebAppDescriptor>> getAllSessionConfig()
Returns all session-config elements

Returns:
list of session-config

removeAllSessionConfig

WebAppDescriptor removeAllSessionConfig()
Removes all session-config elements

Returns:
the current instance of SessionConfigType

getOrCreateMimeMapping

MimeMappingType<WebAppDescriptor> getOrCreateMimeMapping()
If not already created, a new mime-mapping element will be created and returned. Otherwise, the first existing mime-mapping element will be returned.

Returns:
the instance defined for the element mime-mapping

createMimeMapping

MimeMappingType<WebAppDescriptor> createMimeMapping()
Creates a new mime-mapping element

Returns:
the new created instance of MimeMappingType

getAllMimeMapping

List<MimeMappingType<WebAppDescriptor>> getAllMimeMapping()
Returns all mime-mapping elements

Returns:
list of mime-mapping

removeAllMimeMapping

WebAppDescriptor removeAllMimeMapping()
Removes all mime-mapping elements

Returns:
the current instance of MimeMappingType

getOrCreateWelcomeFileList

WelcomeFileListType<WebAppDescriptor> getOrCreateWelcomeFileList()
If not already created, a new welcome-file-list element will be created and returned. Otherwise, the first existing welcome-file-list element will be returned.

Returns:
the instance defined for the element welcome-file-list

createWelcomeFileList

WelcomeFileListType<WebAppDescriptor> createWelcomeFileList()
Creates a new welcome-file-list element

Returns:
the new created instance of WelcomeFileListType

getAllWelcomeFileList

List<WelcomeFileListType<WebAppDescriptor>> getAllWelcomeFileList()
Returns all welcome-file-list elements

Returns:
list of welcome-file-list

removeAllWelcomeFileList

WebAppDescriptor removeAllWelcomeFileList()
Removes all welcome-file-list elements

Returns:
the current instance of WelcomeFileListType

getOrCreateErrorPage

ErrorPageType<WebAppDescriptor> getOrCreateErrorPage()
If not already created, a new error-page element will be created and returned. Otherwise, the first existing error-page element will be returned.

Returns:
the instance defined for the element error-page

createErrorPage

ErrorPageType<WebAppDescriptor> createErrorPage()
Creates a new error-page element

Returns:
the new created instance of ErrorPageType

getAllErrorPage

List<ErrorPageType<WebAppDescriptor>> getAllErrorPage()
Returns all error-page elements

Returns:
list of error-page

removeAllErrorPage

WebAppDescriptor removeAllErrorPage()
Removes all error-page elements

Returns:
the current instance of ErrorPageType

getOrCreateJspConfig

JspConfigType<WebAppDescriptor> getOrCreateJspConfig()
If not already created, a new jsp-config element will be created and returned. Otherwise, the first existing jsp-config element will be returned.

Returns:
the instance defined for the element jsp-config

createJspConfig

JspConfigType<WebAppDescriptor> createJspConfig()
Creates a new jsp-config element

Returns:
the new created instance of JspConfigType

getAllJspConfig

List<JspConfigType<WebAppDescriptor>> getAllJspConfig()
Returns all jsp-config elements

Returns:
list of jsp-config

removeAllJspConfig

WebAppDescriptor removeAllJspConfig()
Removes all jsp-config elements

Returns:
the current instance of JspConfigType

getOrCreateSecurityConstraint

SecurityConstraintType<WebAppDescriptor> getOrCreateSecurityConstraint()
If not already created, a new security-constraint element will be created and returned. Otherwise, the first existing security-constraint element will be returned.

Returns:
the instance defined for the element security-constraint

createSecurityConstraint

SecurityConstraintType<WebAppDescriptor> createSecurityConstraint()
Creates a new security-constraint element

Returns:
the new created instance of SecurityConstraintType

getAllSecurityConstraint

List<SecurityConstraintType<WebAppDescriptor>> getAllSecurityConstraint()
Returns all security-constraint elements

Returns:
list of security-constraint

removeAllSecurityConstraint

WebAppDescriptor removeAllSecurityConstraint()
Removes all security-constraint elements

Returns:
the current instance of SecurityConstraintType

getOrCreateLoginConfig

LoginConfigType<WebAppDescriptor> getOrCreateLoginConfig()
If not already created, a new login-config element will be created and returned. Otherwise, the first existing login-config element will be returned.

Returns:
the instance defined for the element login-config

createLoginConfig

LoginConfigType<WebAppDescriptor> createLoginConfig()
Creates a new login-config element

Returns:
the new created instance of LoginConfigType

getAllLoginConfig

List<LoginConfigType<WebAppDescriptor>> getAllLoginConfig()
Returns all login-config elements

Returns:
list of login-config

removeAllLoginConfig

WebAppDescriptor removeAllLoginConfig()
Removes all login-config elements

Returns:
the current instance of LoginConfigType

getOrCreateSecurityRole

SecurityRoleType<WebAppDescriptor> getOrCreateSecurityRole()
If not already created, a new security-role element will be created and returned. Otherwise, the first existing security-role element will be returned.

Returns:
the instance defined for the element security-role

createSecurityRole

SecurityRoleType<WebAppDescriptor> createSecurityRole()
Creates a new security-role element

Returns:
the new created instance of SecurityRoleType

getAllSecurityRole

List<SecurityRoleType<WebAppDescriptor>> getAllSecurityRole()
Returns all security-role elements

Returns:
list of security-role

removeAllSecurityRole

WebAppDescriptor removeAllSecurityRole()
Removes all security-role elements

Returns:
the current instance of SecurityRoleType

getOrCreateMessageDestination

MessageDestinationType<WebAppDescriptor> getOrCreateMessageDestination()
If not already created, a new message-destination element will be created and returned. Otherwise, the first existing message-destination element will be returned.

Returns:
the instance defined for the element message-destination

createMessageDestination

MessageDestinationType<WebAppDescriptor> createMessageDestination()
Creates a new message-destination element

Returns:
the new created instance of MessageDestinationType

getAllMessageDestination

List<MessageDestinationType<WebAppDescriptor>> getAllMessageDestination()
Returns all message-destination elements

Returns:
list of message-destination

removeAllMessageDestination

WebAppDescriptor removeAllMessageDestination()
Removes all message-destination elements

Returns:
the current instance of MessageDestinationType

getOrCreateLocaleEncodingMappingList

LocaleEncodingMappingListType<WebAppDescriptor> getOrCreateLocaleEncodingMappingList()
If not already created, a new locale-encoding-mapping-list element will be created and returned. Otherwise, the first existing locale-encoding-mapping-list element will be returned.

Returns:
the instance defined for the element locale-encoding-mapping-list

createLocaleEncodingMappingList

LocaleEncodingMappingListType<WebAppDescriptor> createLocaleEncodingMappingList()
Creates a new locale-encoding-mapping-list element

Returns:
the new created instance of LocaleEncodingMappingListType

getAllLocaleEncodingMappingList

List<LocaleEncodingMappingListType<WebAppDescriptor>> getAllLocaleEncodingMappingList()
Returns all locale-encoding-mapping-list elements

Returns:
list of locale-encoding-mapping-list

removeAllLocaleEncodingMappingList

WebAppDescriptor removeAllLocaleEncodingMappingList()
Removes all locale-encoding-mapping-list elements

Returns:
the current instance of LocaleEncodingMappingListType

description

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

getAllDescription

List<String> getAllDescription()
Returns all description elements

Returns:
list of description

removeAllDescription

WebAppDescriptor removeAllDescription()
Removes the description element

Returns:
the current instance of WebAppDescriptor

displayName

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

getAllDisplayName

List<String> getAllDisplayName()
Returns all display-name elements

Returns:
list of display-name

removeAllDisplayName

WebAppDescriptor removeAllDisplayName()
Removes the display-name element

Returns:
the current instance of WebAppDescriptor

getOrCreateIcon

IconType<WebAppDescriptor> 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<WebAppDescriptor> createIcon()
Creates a new icon element

Returns:
the new created instance of IconType

getAllIcon

List<IconType<WebAppDescriptor>> getAllIcon()
Returns all icon elements

Returns:
list of icon

removeAllIcon

WebAppDescriptor removeAllIcon()
Removes all icon elements

Returns:
the current instance of IconType

getOrCreateEnvEntry

EnvEntryType<WebAppDescriptor> getOrCreateEnvEntry()
If not already created, a new env-entry element will be created and returned. Otherwise, the first existing env-entry element will be returned.

Returns:
the instance defined for the element env-entry

createEnvEntry

EnvEntryType<WebAppDescriptor> createEnvEntry()
Creates a new env-entry element

Returns:
the new created instance of EnvEntryType

getAllEnvEntry

List<EnvEntryType<WebAppDescriptor>> getAllEnvEntry()
Returns all env-entry elements

Returns:
list of env-entry

removeAllEnvEntry

WebAppDescriptor removeAllEnvEntry()
Removes all env-entry elements

Returns:
the current instance of EnvEntryType

getOrCreateEjbRef

EjbRefType<WebAppDescriptor> getOrCreateEjbRef()
If not already created, a new ejb-ref element will be created and returned. Otherwise, the first existing ejb-ref element will be returned.

Returns:
the instance defined for the element ejb-ref

createEjbRef

EjbRefType<WebAppDescriptor> createEjbRef()
Creates a new ejb-ref element

Returns:
the new created instance of EjbRefType

getAllEjbRef

List<EjbRefType<WebAppDescriptor>> getAllEjbRef()
Returns all ejb-ref elements

Returns:
list of ejb-ref

removeAllEjbRef

WebAppDescriptor removeAllEjbRef()
Removes all ejb-ref elements

Returns:
the current instance of EjbRefType

getOrCreateEjbLocalRef

EjbLocalRefType<WebAppDescriptor> getOrCreateEjbLocalRef()
If not already created, a new ejb-local-ref element will be created and returned. Otherwise, the first existing ejb-local-ref element will be returned.

Returns:
the instance defined for the element ejb-local-ref

createEjbLocalRef

EjbLocalRefType<WebAppDescriptor> createEjbLocalRef()
Creates a new ejb-local-ref element

Returns:
the new created instance of EjbLocalRefType

getAllEjbLocalRef

List<EjbLocalRefType<WebAppDescriptor>> getAllEjbLocalRef()
Returns all ejb-local-ref elements

Returns:
list of ejb-local-ref

removeAllEjbLocalRef

WebAppDescriptor removeAllEjbLocalRef()
Removes all ejb-local-ref elements

Returns:
the current instance of EjbLocalRefType

getOrCreateResourceRef

ResourceRefType<WebAppDescriptor> getOrCreateResourceRef()
If not already created, a new resource-ref element will be created and returned. Otherwise, the first existing resource-ref element will be returned.

Returns:
the instance defined for the element resource-ref

createResourceRef

ResourceRefType<WebAppDescriptor> createResourceRef()
Creates a new resource-ref element

Returns:
the new created instance of ResourceRefType

getAllResourceRef

List<ResourceRefType<WebAppDescriptor>> getAllResourceRef()
Returns all resource-ref elements

Returns:
list of resource-ref

removeAllResourceRef

WebAppDescriptor removeAllResourceRef()
Removes all resource-ref elements

Returns:
the current instance of ResourceRefType

getOrCreateResourceEnvRef

ResourceEnvRefType<WebAppDescriptor> getOrCreateResourceEnvRef()
If not already created, a new resource-env-ref element will be created and returned. Otherwise, the first existing resource-env-ref element will be returned.

Returns:
the instance defined for the element resource-env-ref

createResourceEnvRef

ResourceEnvRefType<WebAppDescriptor> createResourceEnvRef()
Creates a new resource-env-ref element

Returns:
the new created instance of ResourceEnvRefType

getAllResourceEnvRef

List<ResourceEnvRefType<WebAppDescriptor>> getAllResourceEnvRef()
Returns all resource-env-ref elements

Returns:
list of resource-env-ref

removeAllResourceEnvRef

WebAppDescriptor removeAllResourceEnvRef()
Removes all resource-env-ref elements

Returns:
the current instance of ResourceEnvRefType

getOrCreateMessageDestinationRef

MessageDestinationRefType<WebAppDescriptor> getOrCreateMessageDestinationRef()
If not already created, a new message-destination-ref element will be created and returned. Otherwise, the first existing message-destination-ref element will be returned.

Returns:
the instance defined for the element message-destination-ref

createMessageDestinationRef

MessageDestinationRefType<WebAppDescriptor> createMessageDestinationRef()
Creates a new message-destination-ref element

Returns:
the new created instance of MessageDestinationRefType

getAllMessageDestinationRef

List<MessageDestinationRefType<WebAppDescriptor>> getAllMessageDestinationRef()
Returns all message-destination-ref elements

Returns:
list of message-destination-ref

removeAllMessageDestinationRef

WebAppDescriptor removeAllMessageDestinationRef()
Removes all message-destination-ref elements

Returns:
the current instance of MessageDestinationRefType

getOrCreatePersistenceContextRef

PersistenceContextRefType<WebAppDescriptor> getOrCreatePersistenceContextRef()
If not already created, a new persistence-context-ref element will be created and returned. Otherwise, the first existing persistence-context-ref element will be returned.

Returns:
the instance defined for the element persistence-context-ref

createPersistenceContextRef

PersistenceContextRefType<WebAppDescriptor> createPersistenceContextRef()
Creates a new persistence-context-ref element

Returns:
the new created instance of PersistenceContextRefType

getAllPersistenceContextRef

List<PersistenceContextRefType<WebAppDescriptor>> getAllPersistenceContextRef()
Returns all persistence-context-ref elements

Returns:
list of persistence-context-ref

removeAllPersistenceContextRef

WebAppDescriptor removeAllPersistenceContextRef()
Removes all persistence-context-ref elements

Returns:
the current instance of PersistenceContextRefType

getOrCreatePersistenceUnitRef

PersistenceUnitRefType<WebAppDescriptor> getOrCreatePersistenceUnitRef()
If not already created, a new persistence-unit-ref element will be created and returned. Otherwise, the first existing persistence-unit-ref element will be returned.

Returns:
the instance defined for the element persistence-unit-ref

createPersistenceUnitRef

PersistenceUnitRefType<WebAppDescriptor> createPersistenceUnitRef()
Creates a new persistence-unit-ref element

Returns:
the new created instance of PersistenceUnitRefType

getAllPersistenceUnitRef

List<PersistenceUnitRefType<WebAppDescriptor>> getAllPersistenceUnitRef()
Returns all persistence-unit-ref elements

Returns:
list of persistence-unit-ref

removeAllPersistenceUnitRef

WebAppDescriptor removeAllPersistenceUnitRef()
Removes all persistence-unit-ref elements

Returns:
the current instance of PersistenceUnitRefType

getOrCreatePostConstruct

LifecycleCallbackType<WebAppDescriptor> getOrCreatePostConstruct()
If not already created, a new post-construct element will be created and returned. Otherwise, the first existing post-construct element will be returned.

Returns:
the instance defined for the element post-construct

createPostConstruct

LifecycleCallbackType<WebAppDescriptor> createPostConstruct()
Creates a new post-construct element

Returns:
the new created instance of LifecycleCallbackType

getAllPostConstruct

List<LifecycleCallbackType<WebAppDescriptor>> getAllPostConstruct()
Returns all post-construct elements

Returns:
list of post-construct

removeAllPostConstruct

WebAppDescriptor removeAllPostConstruct()
Removes all post-construct elements

Returns:
the current instance of LifecycleCallbackType

getOrCreatePreDestroy

LifecycleCallbackType<WebAppDescriptor> getOrCreatePreDestroy()
If not already created, a new pre-destroy element will be created and returned. Otherwise, the first existing pre-destroy element will be returned.

Returns:
the instance defined for the element pre-destroy

createPreDestroy

LifecycleCallbackType<WebAppDescriptor> createPreDestroy()
Creates a new pre-destroy element

Returns:
the new created instance of LifecycleCallbackType

getAllPreDestroy

List<LifecycleCallbackType<WebAppDescriptor>> getAllPreDestroy()
Returns all pre-destroy elements

Returns:
list of pre-destroy

removeAllPreDestroy

WebAppDescriptor removeAllPreDestroy()
Removes all pre-destroy elements

Returns:
the current instance of LifecycleCallbackType

getOrCreateDataSource

DataSourceType<WebAppDescriptor> getOrCreateDataSource()
If not already created, a new data-source element will be created and returned. Otherwise, the first existing data-source element will be returned.

Returns:
the instance defined for the element data-source

createDataSource

DataSourceType<WebAppDescriptor> createDataSource()
Creates a new data-source element

Returns:
the new created instance of DataSourceType

getAllDataSource

List<DataSourceType<WebAppDescriptor>> getAllDataSource()
Returns all data-source elements

Returns:
list of data-source

removeAllDataSource

WebAppDescriptor removeAllDataSource()
Removes all data-source elements

Returns:
the current instance of DataSourceType

getOrCreateServiceRef

ServiceRefType<WebAppDescriptor> getOrCreateServiceRef()
If not already created, a new service-ref element will be created and returned. Otherwise, the first existing service-ref element will be returned.

Returns:
the instance defined for the element service-ref

createServiceRef

ServiceRefType<WebAppDescriptor> createServiceRef()
Creates a new service-ref element

Returns:
the new created instance of ServiceRefType

getAllServiceRef

List<ServiceRefType<WebAppDescriptor>> getAllServiceRef()
Returns all service-ref elements

Returns:
list of service-ref

removeAllServiceRef

WebAppDescriptor removeAllServiceRef()
Removes all service-ref elements

Returns:
the current instance of ServiceRefType

version

WebAppDescriptor version(WebAppVersionType version)
Sets the version attribute

Parameters:
version - the value for the attribute version
Returns:
the current instance of WebAppDescriptor

version

WebAppDescriptor version(String version)
Sets the version attribute

Parameters:
version - the value for the attribute version
Returns:
the current instance of WebAppDescriptor

getVersion

WebAppVersionType getVersion()
Returns the version attribute

Returns:
the value defined for the attribute version

getVersionAsString

String getVersionAsString()
Returns the version attribute

Returns:
the value found for the element version

removeVersion

WebAppDescriptor removeVersion()
Removes the version attribute

Returns:
the current instance of WebAppDescriptor

id

WebAppDescriptor id(String id)
Sets the id attribute

Parameters:
id - the value for the attribute id
Returns:
the current instance of WebAppDescriptor

getId

String getId()
Returns the id attribute

Returns:
the value defined for the attribute id

removeId

WebAppDescriptor removeId()
Removes the id attribute

Returns:
the current instance of WebAppDescriptor

metadataComplete

WebAppDescriptor metadataComplete(Boolean metadataComplete)
Sets the metadata-complete attribute

Parameters:
metadataComplete - the value for the attribute metadata-complete
Returns:
the current instance of WebAppDescriptor

isMetadataComplete

Boolean isMetadataComplete()
Returns the metadata-complete attribute

Returns:
the value defined for the attribute metadata-complete

removeMetadataComplete

WebAppDescriptor removeMetadataComplete()
Removes the metadata-complete attribute

Returns:
the current instance of WebAppDescriptor

moduleName

WebAppDescriptor moduleName(String... values)
Creates for all String objects representing module-name elements, a new module-name element

Parameters:
values - list of module-name objects
Returns:
the current instance of WebAppDescriptor

getAllModuleName

List<String> getAllModuleName()
Returns all module-name elements

Returns:
list of module-name

removeAllModuleName

WebAppDescriptor removeAllModuleName()
Removes the module-name element

Returns:
the current instance of WebAppDescriptor

getOrCreateAbsoluteOrdering

AbsoluteOrderingType<WebAppDescriptor> getOrCreateAbsoluteOrdering()
If not already created, a new absolute-ordering element will be created and returned. Otherwise, the first existing absolute-ordering element will be returned.

Returns:
the instance defined for the element absolute-ordering

createAbsoluteOrdering

AbsoluteOrderingType<WebAppDescriptor> createAbsoluteOrdering()
Creates a new absolute-ordering element

Returns:
the new created instance of AbsoluteOrderingType

getAllAbsoluteOrdering

List<AbsoluteOrderingType<WebAppDescriptor>> getAllAbsoluteOrdering()
Returns all absolute-ordering elements

Returns:
list of absolute-ordering

removeAllAbsoluteOrdering

WebAppDescriptor removeAllAbsoluteOrdering()
Removes all absolute-ordering elements

Returns:
the current instance of AbsoluteOrderingType

ShrinkWrap Descriptors Generated Java EE API 2.0.0-alpha-3

Copyright © 2012 JBoss by Red Hat. All Rights Reserved.