org.jboss.shrinkwrap.descriptor.api.ejbjar31
Interface EjbJar31Descriptor

All Superinterfaces:
org.jboss.shrinkwrap.descriptor.api.Descriptor, org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace<EjbJar31Descriptor>
All Known Implementing Classes:
EjbJar31DescriptorImpl

public interface EjbJar31Descriptor
extends org.jboss.shrinkwrap.descriptor.api.Descriptor, org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace<EjbJar31Descriptor>

This deployment descriptor provides the functionalities as described in the ejb-jar_3_1.xsd specification

Example:

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

Since:
Generation date :2011-07-19T22:55:02.759+02:00
Author:
Ralf Battenfeld

Method Summary
 AssemblyDescriptorType<EjbJar31Descriptor> assemblyDescriptor()
          If not already created, a new assembly-descriptor element will be created and returned.
 EnterpriseBeansType<EjbJar31Descriptor> enterpriseBeans()
          If not already created, a new enterprise-beans element will be created and returned.
 java.util.List<java.lang.String> getDescriptionList()
          Returns all description elements
 java.util.List<java.lang.String> getDisplayNameList()
          Returns all display-name elements
 java.lang.String getEjbClientJar()
          Returns the ejb-client-jar element
 java.util.List<IconType<EjbJar31Descriptor>> getIconList()
          Returns all icon elements
 java.lang.String getModuleName()
          Returns the module-name element
 java.lang.String getVersion()
          Returns the version element
 IconType<EjbJar31Descriptor> icon()
          Returns the icon element
 InterceptorsType<EjbJar31Descriptor> interceptors()
          If not already created, a new interceptors element will be created and returned.
 java.lang.Boolean isMetadataComplete()
          Returns the metadata-complete element
 RelationshipsType<EjbJar31Descriptor> relationships()
          If not already created, a new relationships element will be created and returned.
 EjbJar31Descriptor removeAllDescription()
          Removes the description element
 EjbJar31Descriptor removeAllDisplayName()
          Removes the display-name element
 EjbJar31Descriptor removeAllIcon()
          Removes all icon elements
 EjbJar31Descriptor removeAssemblyDescriptor()
          Removes the assembly-descriptor element
 EjbJar31Descriptor removeEjbClientJar()
          Removes the ejb-client-jar element
 EjbJar31Descriptor removeEnterpriseBeans()
          Removes the enterprise-beans element
 EjbJar31Descriptor removeInterceptors()
          Removes the interceptors element
 EjbJar31Descriptor removeMetadataComplete()
          Removes the metadata-complete element
 EjbJar31Descriptor removeModuleName()
          Removes the module-name element
 EjbJar31Descriptor removeRelationships()
          Removes the relationships element
 EjbJar31Descriptor removeVersion()
          Removes the version element
 EjbJar31Descriptor setDescription(java.lang.String description)
          Creates a new description element
 EjbJar31Descriptor setDescriptionList(java.lang.String... values)
          Creates for all String objects representing description elements, a new description element
 EjbJar31Descriptor setDisplayName(java.lang.String displayName)
          Creates a new display-name element
 EjbJar31Descriptor setDisplayNameList(java.lang.String... values)
          Creates for all String objects representing display-name elements, a new display-name element
 EjbJar31Descriptor setEjbClientJar(java.lang.String ejbClientJar)
          If not already created, a new ejb-client-jar element with the given value will be created.
 EjbJar31Descriptor setMetadataComplete(java.lang.Boolean metadataComplete)
          If not already created, a new metadata-complete element with the given value will be created.
 EjbJar31Descriptor setModuleName(java.lang.String moduleName)
          If not already created, a new module-name element with the given value will be created.
 EjbJar31Descriptor setVersion(java.lang.String version)
          If not already created, a new version element with the given value will be created.
 
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

setDescription

EjbJar31Descriptor setDescription(java.lang.String description)
Creates a new description element

Returns:
the current instance of EjbJar31Descriptor

setDescriptionList

EjbJar31Descriptor setDescriptionList(java.lang.String... values)
Creates for all String objects representing description elements, a new description element

Parameters:
list - of description objects
Returns:
the current instance of EjbJar31Descriptor

removeAllDescription

EjbJar31Descriptor removeAllDescription()
Removes the description element

Returns:
the current instance of EjbJar31Descriptor

getDescriptionList

java.util.List<java.lang.String> getDescriptionList()
Returns all description elements

Returns:
list of description

setDisplayName

EjbJar31Descriptor setDisplayName(java.lang.String displayName)
Creates a new display-name element

Returns:
the current instance of EjbJar31Descriptor

setDisplayNameList

EjbJar31Descriptor setDisplayNameList(java.lang.String... values)
Creates for all String objects representing display-name elements, a new display-name element

Parameters:
list - of display-name objects
Returns:
the current instance of EjbJar31Descriptor

removeAllDisplayName

EjbJar31Descriptor removeAllDisplayName()
Removes the display-name element

Returns:
the current instance of EjbJar31Descriptor

getDisplayNameList

java.util.List<java.lang.String> getDisplayNameList()
Returns all display-name elements

Returns:
list of display-name

removeAllIcon

EjbJar31Descriptor removeAllIcon()
Removes all icon elements

Returns:
the current instance of EjbJar31Descriptor

icon

IconType<EjbJar31Descriptor> icon()
Returns the icon element

Returns:
the node defined for the element icon

getIconList

java.util.List<IconType<EjbJar31Descriptor>> getIconList()
Returns all icon elements

Returns:
list of icon

setModuleName

EjbJar31Descriptor setModuleName(java.lang.String moduleName)
If not already created, a new module-name element with the given value will be created. Otherwise, the existing module-name element will be updated with the given value.

Returns:
the current instance of EjbJar31Descriptor

removeModuleName

EjbJar31Descriptor removeModuleName()
Removes the module-name element

Returns:
the current instance of EjbJar31Descriptor

getModuleName

java.lang.String getModuleName()
Returns the module-name element

Returns:
the node defined for the element module-name

removeEnterpriseBeans

EjbJar31Descriptor removeEnterpriseBeans()
Removes the enterprise-beans element

Returns:
the current instance of EjbJar31Descriptor

enterpriseBeans

EnterpriseBeansType<EjbJar31Descriptor> enterpriseBeans()
If not already created, a new enterprise-beans element will be created and returned. Otherwise, the existing enterprise-beans element will be returned.

Returns:
the node defined for the element enterprise-beans

removeInterceptors

EjbJar31Descriptor removeInterceptors()
Removes the interceptors element

Returns:
the current instance of EjbJar31Descriptor

interceptors

InterceptorsType<EjbJar31Descriptor> interceptors()
If not already created, a new interceptors element will be created and returned. Otherwise, the existing interceptors element will be returned.

Returns:
the node defined for the element interceptors

removeRelationships

EjbJar31Descriptor removeRelationships()
Removes the relationships element

Returns:
the current instance of EjbJar31Descriptor

relationships

RelationshipsType<EjbJar31Descriptor> relationships()
If not already created, a new relationships element will be created and returned. Otherwise, the existing relationships element will be returned.

Returns:
the node defined for the element relationships

removeAssemblyDescriptor

EjbJar31Descriptor removeAssemblyDescriptor()
Removes the assembly-descriptor element

Returns:
the current instance of EjbJar31Descriptor

assemblyDescriptor

AssemblyDescriptorType<EjbJar31Descriptor> assemblyDescriptor()
If not already created, a new assembly-descriptor element will be created and returned. Otherwise, the existing assembly-descriptor element will be returned.

Returns:
the node defined for the element assembly-descriptor

setEjbClientJar

EjbJar31Descriptor setEjbClientJar(java.lang.String ejbClientJar)
If not already created, a new ejb-client-jar element with the given value will be created. Otherwise, the existing ejb-client-jar element will be updated with the given value.

Returns:
the current instance of EjbJar31Descriptor

removeEjbClientJar

EjbJar31Descriptor removeEjbClientJar()
Removes the ejb-client-jar element

Returns:
the current instance of EjbJar31Descriptor

getEjbClientJar

java.lang.String getEjbClientJar()
Returns the ejb-client-jar element

Returns:
the node defined for the element ejb-client-jar

setVersion

EjbJar31Descriptor setVersion(java.lang.String version)
If not already created, a new version element with the given value will be created. Otherwise, the existing version element will be updated with the given value.

Returns:
the current instance of EjbJar31Descriptor

removeVersion

EjbJar31Descriptor removeVersion()
Removes the version element

Returns:
the current instance of EjbJar31Descriptor

getVersion

java.lang.String getVersion()
Returns the version element

Returns:
the node defined for the element version

setMetadataComplete

EjbJar31Descriptor setMetadataComplete(java.lang.Boolean metadataComplete)
If not already created, a new metadata-complete element with the given value will be created. Otherwise, the existing metadata-complete element will be updated with the given value.

Returns:
the current instance of EjbJar31Descriptor

removeMetadataComplete

EjbJar31Descriptor removeMetadataComplete()
Removes the metadata-complete element

Returns:
the current instance of EjbJar31Descriptor

isMetadataComplete

java.lang.Boolean isMetadataComplete()
Returns the metadata-complete element

Returns:
the node defined for the element metadata-complete