ShrinkWrap Descriptors Generated Java EE API 2.0.0-alpha-3

org.jboss.shrinkwrap.descriptor.api.webfragment30
Interface WebFragmentDescriptor

All Superinterfaces:
Descriptor, DescriptorNamespace<WebFragmentDescriptor>

public interface WebFragmentDescriptor
extends Descriptor, DescriptorNamespace<WebFragmentDescriptor>

This deployment descriptor provides the functionalities as described in the specification

Example:

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

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

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

WebFragmentDescriptor distributable()
Sets the distributable element

Returns:
the current instance of WebFragmentDescriptor

isDistributable

Boolean isDistributable()
Removes the distributable element

Returns:
the current instance of WebFragmentDescriptor

removeDistributable

WebFragmentDescriptor removeDistributable()
Removes the distributable element

Returns:
the current instance of WebFragmentDescriptor

getOrCreateContextParam

ParamValueType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createContextParam()
Creates a new context-param element

Returns:
the new created instance of ParamValueType

getAllContextParam

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

Returns:
list of context-param

removeAllContextParam

WebFragmentDescriptor removeAllContextParam()
Removes all context-param elements

Returns:
the current instance of ParamValueType

getOrCreateFilter

FilterType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createFilter()
Creates a new filter element

Returns:
the new created instance of FilterType

getAllFilter

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

Returns:
list of filter

removeAllFilter

WebFragmentDescriptor removeAllFilter()
Removes all filter elements

Returns:
the current instance of FilterType

getOrCreateFilterMapping

FilterMappingType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createFilterMapping()
Creates a new filter-mapping element

Returns:
the new created instance of FilterMappingType

getAllFilterMapping

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

Returns:
list of filter-mapping

removeAllFilterMapping

WebFragmentDescriptor removeAllFilterMapping()
Removes all filter-mapping elements

Returns:
the current instance of FilterMappingType

getOrCreateListener

ListenerType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createListener()
Creates a new listener element

Returns:
the new created instance of ListenerType

getAllListener

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

Returns:
list of listener

removeAllListener

WebFragmentDescriptor removeAllListener()
Removes all listener elements

Returns:
the current instance of ListenerType

getOrCreateServlet

ServletType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createServlet()
Creates a new servlet element

Returns:
the new created instance of ServletType

getAllServlet

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

Returns:
list of servlet

removeAllServlet

WebFragmentDescriptor removeAllServlet()
Removes all servlet elements

Returns:
the current instance of ServletType

getOrCreateServletMapping

ServletMappingType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createServletMapping()
Creates a new servlet-mapping element

Returns:
the new created instance of ServletMappingType

getAllServletMapping

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

Returns:
list of servlet-mapping

removeAllServletMapping

WebFragmentDescriptor removeAllServletMapping()
Removes all servlet-mapping elements

Returns:
the current instance of ServletMappingType

getOrCreateSessionConfig

SessionConfigType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createSessionConfig()
Creates a new session-config element

Returns:
the new created instance of SessionConfigType

getAllSessionConfig

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

Returns:
list of session-config

removeAllSessionConfig

WebFragmentDescriptor removeAllSessionConfig()
Removes all session-config elements

Returns:
the current instance of SessionConfigType

getOrCreateMimeMapping

MimeMappingType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createMimeMapping()
Creates a new mime-mapping element

Returns:
the new created instance of MimeMappingType

getAllMimeMapping

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

Returns:
list of mime-mapping

removeAllMimeMapping

WebFragmentDescriptor removeAllMimeMapping()
Removes all mime-mapping elements

Returns:
the current instance of MimeMappingType

getOrCreateWelcomeFileList

WelcomeFileListType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createWelcomeFileList()
Creates a new welcome-file-list element

Returns:
the new created instance of WelcomeFileListType

getAllWelcomeFileList

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

Returns:
list of welcome-file-list

removeAllWelcomeFileList

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

Returns:
the current instance of WelcomeFileListType

getOrCreateErrorPage

ErrorPageType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createErrorPage()
Creates a new error-page element

Returns:
the new created instance of ErrorPageType

getAllErrorPage

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

Returns:
list of error-page

removeAllErrorPage

WebFragmentDescriptor removeAllErrorPage()
Removes all error-page elements

Returns:
the current instance of ErrorPageType

getOrCreateJspConfig

JspConfigType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createJspConfig()
Creates a new jsp-config element

Returns:
the new created instance of JspConfigType

getAllJspConfig

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

Returns:
list of jsp-config

removeAllJspConfig

WebFragmentDescriptor removeAllJspConfig()
Removes all jsp-config elements

Returns:
the current instance of JspConfigType

getOrCreateSecurityConstraint

SecurityConstraintType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createSecurityConstraint()
Creates a new security-constraint element

Returns:
the new created instance of SecurityConstraintType

getAllSecurityConstraint

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

Returns:
list of security-constraint

removeAllSecurityConstraint

WebFragmentDescriptor removeAllSecurityConstraint()
Removes all security-constraint elements

Returns:
the current instance of SecurityConstraintType

getOrCreateLoginConfig

LoginConfigType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createLoginConfig()
Creates a new login-config element

Returns:
the new created instance of LoginConfigType

getAllLoginConfig

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

Returns:
list of login-config

removeAllLoginConfig

WebFragmentDescriptor removeAllLoginConfig()
Removes all login-config elements

Returns:
the current instance of LoginConfigType

getOrCreateSecurityRole

SecurityRoleType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createSecurityRole()
Creates a new security-role element

Returns:
the new created instance of SecurityRoleType

getAllSecurityRole

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

Returns:
list of security-role

removeAllSecurityRole

WebFragmentDescriptor removeAllSecurityRole()
Removes all security-role elements

Returns:
the current instance of SecurityRoleType

getOrCreateMessageDestination

MessageDestinationType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createMessageDestination()
Creates a new message-destination element

Returns:
the new created instance of MessageDestinationType

getAllMessageDestination

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

Returns:
list of message-destination

removeAllMessageDestination

WebFragmentDescriptor removeAllMessageDestination()
Removes all message-destination elements

Returns:
the current instance of MessageDestinationType

getOrCreateLocaleEncodingMappingList

LocaleEncodingMappingListType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createLocaleEncodingMappingList()
Creates a new locale-encoding-mapping-list element

Returns:
the new created instance of LocaleEncodingMappingListType

getAllLocaleEncodingMappingList

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

Returns:
list of locale-encoding-mapping-list

removeAllLocaleEncodingMappingList

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

Returns:
the current instance of LocaleEncodingMappingListType

description

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

getAllDescription

List<String> getAllDescription()
Returns all description elements

Returns:
list of description

removeAllDescription

WebFragmentDescriptor removeAllDescription()
Removes the description element

Returns:
the current instance of WebFragmentDescriptor

displayName

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

getAllDisplayName

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

Returns:
list of display-name

removeAllDisplayName

WebFragmentDescriptor removeAllDisplayName()
Removes the display-name element

Returns:
the current instance of WebFragmentDescriptor

getOrCreateIcon

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

Returns:
the new created instance of IconType

getAllIcon

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

Returns:
list of icon

removeAllIcon

WebFragmentDescriptor removeAllIcon()
Removes all icon elements

Returns:
the current instance of IconType

getOrCreateEnvEntry

EnvEntryType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createEnvEntry()
Creates a new env-entry element

Returns:
the new created instance of EnvEntryType

getAllEnvEntry

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

Returns:
list of env-entry

removeAllEnvEntry

WebFragmentDescriptor removeAllEnvEntry()
Removes all env-entry elements

Returns:
the current instance of EnvEntryType

getOrCreateEjbRef

EjbRefType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createEjbRef()
Creates a new ejb-ref element

Returns:
the new created instance of EjbRefType

getAllEjbRef

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

Returns:
list of ejb-ref

removeAllEjbRef

WebFragmentDescriptor removeAllEjbRef()
Removes all ejb-ref elements

Returns:
the current instance of EjbRefType

getOrCreateEjbLocalRef

EjbLocalRefType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createEjbLocalRef()
Creates a new ejb-local-ref element

Returns:
the new created instance of EjbLocalRefType

getAllEjbLocalRef

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

Returns:
list of ejb-local-ref

removeAllEjbLocalRef

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

Returns:
the current instance of EjbLocalRefType

getOrCreateResourceRef

ResourceRefType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createResourceRef()
Creates a new resource-ref element

Returns:
the new created instance of ResourceRefType

getAllResourceRef

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

Returns:
list of resource-ref

removeAllResourceRef

WebFragmentDescriptor removeAllResourceRef()
Removes all resource-ref elements

Returns:
the current instance of ResourceRefType

getOrCreateResourceEnvRef

ResourceEnvRefType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createResourceEnvRef()
Creates a new resource-env-ref element

Returns:
the new created instance of ResourceEnvRefType

getAllResourceEnvRef

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

Returns:
list of resource-env-ref

removeAllResourceEnvRef

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

Returns:
the current instance of ResourceEnvRefType

getOrCreateMessageDestinationRef

MessageDestinationRefType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createMessageDestinationRef()
Creates a new message-destination-ref element

Returns:
the new created instance of MessageDestinationRefType

getAllMessageDestinationRef

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

Returns:
list of message-destination-ref

removeAllMessageDestinationRef

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

Returns:
the current instance of MessageDestinationRefType

getOrCreatePersistenceContextRef

PersistenceContextRefType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createPersistenceContextRef()
Creates a new persistence-context-ref element

Returns:
the new created instance of PersistenceContextRefType

getAllPersistenceContextRef

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

Returns:
list of persistence-context-ref

removeAllPersistenceContextRef

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

Returns:
the current instance of PersistenceContextRefType

getOrCreatePersistenceUnitRef

PersistenceUnitRefType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createPersistenceUnitRef()
Creates a new persistence-unit-ref element

Returns:
the new created instance of PersistenceUnitRefType

getAllPersistenceUnitRef

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

Returns:
list of persistence-unit-ref

removeAllPersistenceUnitRef

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

Returns:
the current instance of PersistenceUnitRefType

getOrCreatePostConstruct

LifecycleCallbackType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createPostConstruct()
Creates a new post-construct element

Returns:
the new created instance of LifecycleCallbackType

getAllPostConstruct

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

Returns:
list of post-construct

removeAllPostConstruct

WebFragmentDescriptor removeAllPostConstruct()
Removes all post-construct elements

Returns:
the current instance of LifecycleCallbackType

getOrCreatePreDestroy

LifecycleCallbackType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createPreDestroy()
Creates a new pre-destroy element

Returns:
the new created instance of LifecycleCallbackType

getAllPreDestroy

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

Returns:
list of pre-destroy

removeAllPreDestroy

WebFragmentDescriptor removeAllPreDestroy()
Removes all pre-destroy elements

Returns:
the current instance of LifecycleCallbackType

getOrCreateDataSource

DataSourceType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createDataSource()
Creates a new data-source element

Returns:
the new created instance of DataSourceType

getAllDataSource

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

Returns:
list of data-source

removeAllDataSource

WebFragmentDescriptor removeAllDataSource()
Removes all data-source elements

Returns:
the current instance of DataSourceType

getOrCreateServiceRef

ServiceRefType<WebFragmentDescriptor> 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<WebFragmentDescriptor> createServiceRef()
Creates a new service-ref element

Returns:
the new created instance of ServiceRefType

getAllServiceRef

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

Returns:
list of service-ref

removeAllServiceRef

WebFragmentDescriptor removeAllServiceRef()
Removes all service-ref elements

Returns:
the current instance of ServiceRefType

version

WebFragmentDescriptor version(WebAppVersionType version)
Sets the version attribute

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

version

WebFragmentDescriptor version(String version)
Sets the version attribute

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

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

WebFragmentDescriptor removeVersion()
Removes the version attribute

Returns:
the current instance of WebFragmentDescriptor

id

WebFragmentDescriptor id(String id)
Sets the id attribute

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

getId

String getId()
Returns the id attribute

Returns:
the value defined for the attribute id

removeId

WebFragmentDescriptor removeId()
Removes the id attribute

Returns:
the current instance of WebFragmentDescriptor

metadataComplete

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

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

isMetadataComplete

Boolean isMetadataComplete()
Returns the metadata-complete attribute

Returns:
the value defined for the attribute metadata-complete

removeMetadataComplete

WebFragmentDescriptor removeMetadataComplete()
Removes the metadata-complete attribute

Returns:
the current instance of WebFragmentDescriptor

name

WebFragmentDescriptor name(String... values)
Creates for all String objects representing name elements, a new name element

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

getAllName

List<String> getAllName()
Returns all name elements

Returns:
list of name

removeAllName

WebFragmentDescriptor removeAllName()
Removes the name element

Returns:
the current instance of WebFragmentDescriptor

getOrCreateOrdering

OrderingType<WebFragmentDescriptor> getOrCreateOrdering()
If not already created, a new ordering element will be created and returned. Otherwise, the first existing ordering element will be returned.

Returns:
the instance defined for the element ordering

createOrdering

OrderingType<WebFragmentDescriptor> createOrdering()
Creates a new ordering element

Returns:
the new created instance of OrderingType

getAllOrdering

List<OrderingType<WebFragmentDescriptor>> getAllOrdering()
Returns all ordering elements

Returns:
list of ordering

removeAllOrdering

WebFragmentDescriptor removeAllOrdering()
Removes all ordering elements

Returns:
the current instance of OrderingType

ShrinkWrap Descriptors Generated Java EE API 2.0.0-alpha-3

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