ShrinkWrap Descriptors Generated Java EE API 2.0.0-alpha-3

org.jboss.shrinkwrap.descriptor.api.application6
Interface ApplicationDescriptor

All Superinterfaces:
Descriptor, DescriptorNamespace<ApplicationDescriptor>

public interface ApplicationDescriptor
extends Descriptor, DescriptorNamespace<ApplicationDescriptor>

This deployment descriptor provides the functionalities as described in the specification

Example:

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

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

Method Summary
 ApplicationDescriptor applicationName(String applicationName)
          Sets the application-name element
 DataSourceType<ApplicationDescriptor> createDataSource()
          Creates a new data-source element
 EjbLocalRefType<ApplicationDescriptor> createEjbLocalRef()
          Creates a new ejb-local-ref element
 EjbRefType<ApplicationDescriptor> createEjbRef()
          Creates a new ejb-ref element
 EnvEntryType<ApplicationDescriptor> createEnvEntry()
          Creates a new env-entry element
 IconType<ApplicationDescriptor> createIcon()
          Creates a new icon element
 MessageDestinationType<ApplicationDescriptor> createMessageDestination()
          Creates a new message-destination element
 MessageDestinationRefType<ApplicationDescriptor> createMessageDestinationRef()
          Creates a new message-destination-ref element
 ModuleType<ApplicationDescriptor> createModule()
          Creates a new module element
 PersistenceContextRefType<ApplicationDescriptor> createPersistenceContextRef()
          Creates a new persistence-context-ref element
 PersistenceUnitRefType<ApplicationDescriptor> createPersistenceUnitRef()
          Creates a new persistence-unit-ref element
 ResourceEnvRefType<ApplicationDescriptor> createResourceEnvRef()
          Creates a new resource-env-ref element
 ResourceRefType<ApplicationDescriptor> createResourceRef()
          Creates a new resource-ref element
 SecurityRoleType<ApplicationDescriptor> createSecurityRole()
          Creates a new security-role element
 ServiceRefType<ApplicationDescriptor> createServiceRef()
          Creates a new service-ref element
 ApplicationDescriptor description(String... values)
          Creates for all String objects representing description elements, a new description element
 ApplicationDescriptor displayName(String... values)
          Creates for all String objects representing display-name elements, a new display-name element
 List<DataSourceType<ApplicationDescriptor>> getAllDataSource()
          Returns all data-source elements
 List<String> getAllDescription()
          Returns all description elements
 List<String> getAllDisplayName()
          Returns all display-name elements
 List<EjbLocalRefType<ApplicationDescriptor>> getAllEjbLocalRef()
          Returns all ejb-local-ref elements
 List<EjbRefType<ApplicationDescriptor>> getAllEjbRef()
          Returns all ejb-ref elements
 List<EnvEntryType<ApplicationDescriptor>> getAllEnvEntry()
          Returns all env-entry elements
 List<IconType<ApplicationDescriptor>> getAllIcon()
          Returns all icon elements
 List<MessageDestinationType<ApplicationDescriptor>> getAllMessageDestination()
          Returns all message-destination elements
 List<MessageDestinationRefType<ApplicationDescriptor>> getAllMessageDestinationRef()
          Returns all message-destination-ref elements
 List<ModuleType<ApplicationDescriptor>> getAllModule()
          Returns all module elements
 List<PersistenceContextRefType<ApplicationDescriptor>> getAllPersistenceContextRef()
          Returns all persistence-context-ref elements
 List<PersistenceUnitRefType<ApplicationDescriptor>> getAllPersistenceUnitRef()
          Returns all persistence-unit-ref elements
 List<ResourceEnvRefType<ApplicationDescriptor>> getAllResourceEnvRef()
          Returns all resource-env-ref elements
 List<ResourceRefType<ApplicationDescriptor>> getAllResourceRef()
          Returns all resource-ref elements
 List<SecurityRoleType<ApplicationDescriptor>> getAllSecurityRole()
          Returns all security-role elements
 List<ServiceRefType<ApplicationDescriptor>> getAllServiceRef()
          Returns all service-ref elements
 String getApplicationName()
          Returns the application-name element
 GenericBooleanType getInitializeInOrder()
          Returns the initialize-in-order element
 String getInitializeInOrderAsString()
          Returns the initialize-in-order element
 String getLibraryDirectory()
          Returns the library-directory element
 DataSourceType<ApplicationDescriptor> getOrCreateDataSource()
          If not already created, a new data-source element will be created and returned.
 EjbLocalRefType<ApplicationDescriptor> getOrCreateEjbLocalRef()
          If not already created, a new ejb-local-ref element will be created and returned.
 EjbRefType<ApplicationDescriptor> getOrCreateEjbRef()
          If not already created, a new ejb-ref element will be created and returned.
 EnvEntryType<ApplicationDescriptor> getOrCreateEnvEntry()
          If not already created, a new env-entry element will be created and returned.
 IconType<ApplicationDescriptor> getOrCreateIcon()
          If not already created, a new icon element will be created and returned.
 MessageDestinationType<ApplicationDescriptor> getOrCreateMessageDestination()
          If not already created, a new message-destination element will be created and returned.
 MessageDestinationRefType<ApplicationDescriptor> getOrCreateMessageDestinationRef()
          If not already created, a new message-destination-ref element will be created and returned.
 ModuleType<ApplicationDescriptor> getOrCreateModule()
          If not already created, a new module element will be created and returned.
 PersistenceContextRefType<ApplicationDescriptor> getOrCreatePersistenceContextRef()
          If not already created, a new persistence-context-ref element will be created and returned.
 PersistenceUnitRefType<ApplicationDescriptor> getOrCreatePersistenceUnitRef()
          If not already created, a new persistence-unit-ref element will be created and returned.
 ResourceEnvRefType<ApplicationDescriptor> getOrCreateResourceEnvRef()
          If not already created, a new resource-env-ref element will be created and returned.
 ResourceRefType<ApplicationDescriptor> getOrCreateResourceRef()
          If not already created, a new resource-ref element will be created and returned.
 SecurityRoleType<ApplicationDescriptor> getOrCreateSecurityRole()
          If not already created, a new security-role element will be created and returned.
 ServiceRefType<ApplicationDescriptor> getOrCreateServiceRef()
          If not already created, a new service-ref element will be created and returned.
 String getVersion()
          Returns the version attribute
 ApplicationDescriptor initializeInOrder(GenericBooleanType initializeInOrder)
          Sets the initialize-in-order element
 ApplicationDescriptor initializeInOrder(String initializeInOrder)
          Sets the initialize-in-order element
 ApplicationDescriptor libraryDirectory(String libraryDirectory)
          Sets the library-directory element
 ApplicationDescriptor removeAllDataSource()
          Removes all data-source elements
 ApplicationDescriptor removeAllDescription()
          Removes the description element
 ApplicationDescriptor removeAllDisplayName()
          Removes the display-name element
 ApplicationDescriptor removeAllEjbLocalRef()
          Removes all ejb-local-ref elements
 ApplicationDescriptor removeAllEjbRef()
          Removes all ejb-ref elements
 ApplicationDescriptor removeAllEnvEntry()
          Removes all env-entry elements
 ApplicationDescriptor removeAllIcon()
          Removes all icon elements
 ApplicationDescriptor removeAllMessageDestination()
          Removes all message-destination elements
 ApplicationDescriptor removeAllMessageDestinationRef()
          Removes all message-destination-ref elements
 ApplicationDescriptor removeAllModule()
          Removes all module elements
 ApplicationDescriptor removeAllPersistenceContextRef()
          Removes all persistence-context-ref elements
 ApplicationDescriptor removeAllPersistenceUnitRef()
          Removes all persistence-unit-ref elements
 ApplicationDescriptor removeAllResourceEnvRef()
          Removes all resource-env-ref elements
 ApplicationDescriptor removeAllResourceRef()
          Removes all resource-ref elements
 ApplicationDescriptor removeAllSecurityRole()
          Removes all security-role elements
 ApplicationDescriptor removeAllServiceRef()
          Removes all service-ref elements
 ApplicationDescriptor removeApplicationName()
          Removes the application-name element
 ApplicationDescriptor removeInitializeInOrder()
          Removes the initialize-in-order attribute
 ApplicationDescriptor removeLibraryDirectory()
          Removes the library-directory element
 ApplicationDescriptor removeVersion()
          Removes the version attribute
 ApplicationDescriptor version(String 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

description

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

getAllDescription

List<String> getAllDescription()
Returns all description elements

Returns:
list of description

removeAllDescription

ApplicationDescriptor removeAllDescription()
Removes the description element

Returns:
the current instance of ApplicationDescriptor

displayName

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

getAllDisplayName

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

Returns:
list of display-name

removeAllDisplayName

ApplicationDescriptor removeAllDisplayName()
Removes the display-name element

Returns:
the current instance of ApplicationDescriptor

getOrCreateIcon

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

Returns:
the new created instance of IconType

getAllIcon

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

Returns:
list of icon

removeAllIcon

ApplicationDescriptor removeAllIcon()
Removes all icon elements

Returns:
the current instance of IconType

getOrCreateServiceRef

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

Returns:
the new created instance of ServiceRefType

getAllServiceRef

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

Returns:
list of service-ref

removeAllServiceRef

ApplicationDescriptor removeAllServiceRef()
Removes all service-ref elements

Returns:
the current instance of ServiceRefType

applicationName

ApplicationDescriptor applicationName(String applicationName)
Sets the application-name element

Parameters:
applicationName - the value for the element application-name
Returns:
the current instance of ApplicationDescriptor

getApplicationName

String getApplicationName()
Returns the application-name element

Returns:
the node defined for the element application-name

removeApplicationName

ApplicationDescriptor removeApplicationName()
Removes the application-name element

Returns:
the current instance of ApplicationDescriptor

initializeInOrder

ApplicationDescriptor initializeInOrder(GenericBooleanType initializeInOrder)
Sets the initialize-in-order element

Parameters:
initializeInOrder - the value for the element initialize-in-order
Returns:
the current instance of ApplicationDescriptor

initializeInOrder

ApplicationDescriptor initializeInOrder(String initializeInOrder)
Sets the initialize-in-order element

Parameters:
initializeInOrder - the value for the element initialize-in-order
Returns:
the current instance of ApplicationDescriptor

getInitializeInOrder

GenericBooleanType getInitializeInOrder()
Returns the initialize-in-order element

Returns:
the value found for the element initialize-in-order

getInitializeInOrderAsString

String getInitializeInOrderAsString()
Returns the initialize-in-order element

Returns:
the value found for the element initialize-in-order

removeInitializeInOrder

ApplicationDescriptor removeInitializeInOrder()
Removes the initialize-in-order attribute

Returns:
the current instance of ApplicationDescriptor

getOrCreateModule

ModuleType<ApplicationDescriptor> getOrCreateModule()
If not already created, a new module element will be created and returned. Otherwise, the first existing module element will be returned.

Returns:
the instance defined for the element module

createModule

ModuleType<ApplicationDescriptor> createModule()
Creates a new module element

Returns:
the new created instance of ModuleType

getAllModule

List<ModuleType<ApplicationDescriptor>> getAllModule()
Returns all module elements

Returns:
list of module

removeAllModule

ApplicationDescriptor removeAllModule()
Removes all module elements

Returns:
the current instance of ModuleType

getOrCreateSecurityRole

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

Returns:
the new created instance of SecurityRoleType

getAllSecurityRole

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

Returns:
list of security-role

removeAllSecurityRole

ApplicationDescriptor removeAllSecurityRole()
Removes all security-role elements

Returns:
the current instance of SecurityRoleType

libraryDirectory

ApplicationDescriptor libraryDirectory(String libraryDirectory)
Sets the library-directory element

Parameters:
libraryDirectory - the value for the element library-directory
Returns:
the current instance of ApplicationDescriptor

getLibraryDirectory

String getLibraryDirectory()
Returns the library-directory element

Returns:
the node defined for the element library-directory

removeLibraryDirectory

ApplicationDescriptor removeLibraryDirectory()
Removes the library-directory element

Returns:
the current instance of ApplicationDescriptor

getOrCreateEnvEntry

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

Returns:
the new created instance of EnvEntryType

getAllEnvEntry

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

Returns:
list of env-entry

removeAllEnvEntry

ApplicationDescriptor removeAllEnvEntry()
Removes all env-entry elements

Returns:
the current instance of EnvEntryType

getOrCreateEjbRef

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

Returns:
the new created instance of EjbRefType

getAllEjbRef

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

Returns:
list of ejb-ref

removeAllEjbRef

ApplicationDescriptor removeAllEjbRef()
Removes all ejb-ref elements

Returns:
the current instance of EjbRefType

getOrCreateEjbLocalRef

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

Returns:
the new created instance of EjbLocalRefType

getAllEjbLocalRef

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

Returns:
list of ejb-local-ref

removeAllEjbLocalRef

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

Returns:
the current instance of EjbLocalRefType

getOrCreateResourceRef

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

Returns:
the new created instance of ResourceRefType

getAllResourceRef

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

Returns:
list of resource-ref

removeAllResourceRef

ApplicationDescriptor removeAllResourceRef()
Removes all resource-ref elements

Returns:
the current instance of ResourceRefType

getOrCreateResourceEnvRef

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

Returns:
the new created instance of ResourceEnvRefType

getAllResourceEnvRef

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

Returns:
list of resource-env-ref

removeAllResourceEnvRef

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

Returns:
the current instance of ResourceEnvRefType

getOrCreateMessageDestinationRef

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

Returns:
the new created instance of MessageDestinationRefType

getAllMessageDestinationRef

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

Returns:
list of message-destination-ref

removeAllMessageDestinationRef

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

Returns:
the current instance of MessageDestinationRefType

getOrCreatePersistenceContextRef

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

Returns:
the new created instance of PersistenceContextRefType

getAllPersistenceContextRef

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

Returns:
list of persistence-context-ref

removeAllPersistenceContextRef

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

Returns:
the current instance of PersistenceContextRefType

getOrCreatePersistenceUnitRef

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

Returns:
the new created instance of PersistenceUnitRefType

getAllPersistenceUnitRef

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

Returns:
list of persistence-unit-ref

removeAllPersistenceUnitRef

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

Returns:
the current instance of PersistenceUnitRefType

getOrCreateMessageDestination

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

Returns:
the new created instance of MessageDestinationType

getAllMessageDestination

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

Returns:
list of message-destination

removeAllMessageDestination

ApplicationDescriptor removeAllMessageDestination()
Removes all message-destination elements

Returns:
the current instance of MessageDestinationType

getOrCreateDataSource

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

Returns:
the new created instance of DataSourceType

getAllDataSource

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

Returns:
list of data-source

removeAllDataSource

ApplicationDescriptor removeAllDataSource()
Removes all data-source elements

Returns:
the current instance of DataSourceType

version

ApplicationDescriptor version(String version)
Sets the version attribute

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

getVersion

String getVersion()
Returns the version attribute

Returns:
the value defined for the attribute version

removeVersion

ApplicationDescriptor removeVersion()
Removes the version attribute

Returns:
the current instance of ApplicationDescriptor

ShrinkWrap Descriptors Generated Java EE API 2.0.0-alpha-3

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