EjbJarDescriptor (ShrinkWrap Descriptors Aggregator 2.0.0 API)

All Superinterfaces:

Descriptor, DescriptorNamespace<EjbJarDescriptor>, EjbJarCommonDescriptor<EjbJarDescriptor,EnterpriseBeansType<EjbJarDescriptor>>
```
public interface EjbJarDescriptor
extends Descriptor, DescriptorNamespace<EjbJarDescriptor>, EjbJarCommonDescriptor<EjbJarDescriptor,EnterpriseBeansType<EjbJarDescriptor>>
```
This deployment descriptor provides the functionalities as described in the specification
Example:
EjbJarDescriptor descriptor = Descriptors.create(EjbJarDescriptor.class);

Author:

Ralf Battenfeld, Andrew Lee Rubinger, George Gastaldi

Field Summary

Fields
Modifier and Type Field and Description

static String VERSION

Fields
Modifier and Type	Field and Description
`static String`	`VERSION`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`IconType<EjbJarDescriptor>`	`createIcon()` Creates a new `icon` element
`EjbJarDescriptor`	`description(String... values)` Creates for all String objects representing `description` elements, a new `description` element
`EjbJarDescriptor`	`displayName(String... values)` Creates for all String objects representing `display-name` elements, a new `display-name` element
`EjbJarDescriptor`	`ejbClientJar(String ejbClientJar)` Sets the `ejb-client-jar` element
`List<String>`	`getAllDescription()` Returns all `description` elements
`List<String>`	`getAllDisplayName()` Returns all `display-name` elements
`List<IconType<EjbJarDescriptor>>`	`getAllIcon()` Returns all `icon` elements
`String`	`getEjbClientJar()` Returns the `ejb-client-jar` element
`String`	`getId()` Returns the `id` attribute
`String`	`getModuleName()` Returns the `module-name` element
`AssemblyDescriptorType<EjbJarDescriptor>`	`getOrCreateAssemblyDescriptor()` If not already created, a new `assembly-descriptor` element with the given value will be created.
`EnterpriseBeansType<EjbJarDescriptor>`	`getOrCreateEnterpriseBeans()` If not already created, a new `enterprise-beans` element with the given value will be created.
`IconType<EjbJarDescriptor>`	`getOrCreateIcon()` If not already created, a new `icon` element will be created and returned.
`InterceptorsType<EjbJarDescriptor>`	`getOrCreateInterceptors()` If not already created, a new `interceptors` element with the given value will be created.
`RelationshipsType<EjbJarDescriptor>`	`getOrCreateRelationships()` If not already created, a new `relationships` element with the given value will be created.
`String`	`getVersion()` Returns the `version` attribute
`EjbJarDescriptor`	`id(String id)` Sets the `id` attribute
`Boolean`	`isMetadataComplete()` Returns the `metadata-complete` attribute
`EjbJarDescriptor`	`metadataComplete(Boolean metadataComplete)` Sets the `metadata-complete` attribute
`EjbJarDescriptor`	`moduleName(String moduleName)` Sets the `module-name` element
`EjbJarDescriptor`	`removeAllDescription()` Removes the `description` element
`EjbJarDescriptor`	`removeAllDisplayName()` Removes the `display-name` element
`EjbJarDescriptor`	`removeAllIcon()` Removes all `icon` elements
`EjbJarDescriptor`	`removeAssemblyDescriptor()` Removes the `assembly-descriptor` element
`EjbJarDescriptor`	`removeEjbClientJar()` Removes the `ejb-client-jar` element
`EjbJarDescriptor`	`removeEnterpriseBeans()` Removes the `enterprise-beans` element
`EjbJarDescriptor`	`removeId()` Removes the `id` attribute
`EjbJarDescriptor`	`removeInterceptors()` Removes the `interceptors` element
`EjbJarDescriptor`	`removeMetadataComplete()` Removes the `metadata-complete` attribute
`EjbJarDescriptor`	`removeModuleName()` Removes the `module-name` element
`EjbJarDescriptor`	`removeRelationships()` Removes the `relationships` element
`EjbJarDescriptor`	`removeVersion()` Removes the `version` attribute
`EjbJarDescriptor`	`version(String version)` Sets the `version` attribute

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace
addDefaultNamespaces, addNamespace, getNamespaces, removeAllNamespaces

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Descriptor
exportAsString, exportTo, getDescriptorName

- Field Detail
  - VERSION
```
static final String VERSION
```
    See Also:
    
    Constant Field Values
- Method Detail
  - description
```
EjbJarDescriptor 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 EjbJarDescriptor
  - getAllDescription
```
List<String> getAllDescription()
```
    Returns all description elements
    
    Returns:
    
    list of description
  - removeAllDescription
```
EjbJarDescriptor removeAllDescription()
```
    Removes the description element
    
    Returns:
    
    the current instance of EjbJarDescriptor
  - displayName
```
EjbJarDescriptor 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 EjbJarDescriptor
  - getAllDisplayName
```
List<String> getAllDisplayName()
```
    Returns all display-name elements
    
    Returns:
    
    list of display-name
  - removeAllDisplayName
```
EjbJarDescriptor removeAllDisplayName()
```
    Removes the display-name element
    
    Returns:
    
    the current instance of EjbJarDescriptor
  - getOrCreateIcon
```
IconType<EjbJarDescriptor> 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<EjbJarDescriptor> createIcon()
```
    Creates a new icon element
    
    Returns:
    
    the new created instance of IconType
  - getAllIcon
```
List<IconType<EjbJarDescriptor>> getAllIcon()
```
    Returns all icon elements
    
    Returns:
    
    list of icon
  - removeAllIcon
```
EjbJarDescriptor removeAllIcon()
```
    Removes all icon elements
    
    Returns:
    
    the current instance of IconType
  - moduleName
```
EjbJarDescriptor moduleName(String moduleName)
```
    Sets the module-name element
    
    Parameters:
    
    moduleName - the value for the element module-name
    
    Returns:
    
    the current instance of EjbJarDescriptor
  - getModuleName
```
String getModuleName()
```
    Returns the module-name element
    
    Returns:
    
    the node defined for the element module-name
  - removeModuleName
```
EjbJarDescriptor removeModuleName()
```
    Removes the module-name element
    
    Returns:
    
    the current instance of EjbJarDescriptor
  - getOrCreateEnterpriseBeans
```
EnterpriseBeansType<EjbJarDescriptor> getOrCreateEnterpriseBeans()
```
    If not already created, a new enterprise-beans element with the given value will be created. Otherwise, the existing enterprise-beans element will be returned.
    
    Returns:
    
    a new or existing instance of EnterpriseBeansType
  - removeEnterpriseBeans
```
EjbJarDescriptor removeEnterpriseBeans()
```
    Removes the enterprise-beans element
    
    Returns:
    
    the current instance of EjbJarDescriptor
  - getOrCreateInterceptors
```
InterceptorsType<EjbJarDescriptor> getOrCreateInterceptors()
```
    If not already created, a new interceptors element with the given value will be created. Otherwise, the existing interceptors element will be returned.
    
    Returns:
    
    a new or existing instance of InterceptorsType
  - removeInterceptors
```
EjbJarDescriptor removeInterceptors()
```
    Removes the interceptors element
    
    Returns:
    
    the current instance of EjbJarDescriptor
  - getOrCreateRelationships
```
RelationshipsType<EjbJarDescriptor> getOrCreateRelationships()
```
    If not already created, a new relationships element with the given value will be created. Otherwise, the existing relationships element will be returned.
    
    Returns:
    
    a new or existing instance of RelationshipsType
  - removeRelationships
```
EjbJarDescriptor removeRelationships()
```
    Removes the relationships element
    
    Returns:
    
    the current instance of EjbJarDescriptor
  - getOrCreateAssemblyDescriptor
```
AssemblyDescriptorType<EjbJarDescriptor> getOrCreateAssemblyDescriptor()
```
    If not already created, a new assembly-descriptor element with the given value will be created. Otherwise, the existing assembly-descriptor element will be returned.
    
    Returns:
    
    a new or existing instance of AssemblyDescriptorType
  - removeAssemblyDescriptor
```
EjbJarDescriptor removeAssemblyDescriptor()
```
    Removes the assembly-descriptor element
    
    Returns:
    
    the current instance of EjbJarDescriptor
  - ejbClientJar
```
EjbJarDescriptor ejbClientJar(String ejbClientJar)
```
    Sets the ejb-client-jar element
    
    Parameters:
    
    ejbClientJar - the value for the element ejb-client-jar
    
    Returns:
    
    the current instance of EjbJarDescriptor
  - getEjbClientJar
```
String getEjbClientJar()
```
    Returns the ejb-client-jar element
    
    Returns:
    
    the node defined for the element ejb-client-jar
  - removeEjbClientJar
```
EjbJarDescriptor removeEjbClientJar()
```
    Removes the ejb-client-jar element
    
    Returns:
    
    the current instance of EjbJarDescriptor
  - version
```
EjbJarDescriptor version(String version)
```
    Sets the version attribute
    
    Specified by:
    
    version in interface EjbJarCommonDescriptor<EjbJarDescriptor,EnterpriseBeansType<EjbJarDescriptor>>
    
    Parameters:
    
    version - the value for the attribute version
    
    Returns:
    
    the current instance of EjbJarDescriptor
  - getVersion
```
String getVersion()
```
    Returns the version attribute
    
    Specified by:
    
    getVersion in interface EjbJarCommonDescriptor<EjbJarDescriptor,EnterpriseBeansType<EjbJarDescriptor>>
    
    Returns:
    
    the value defined for the attribute version
  - removeVersion
```
EjbJarDescriptor removeVersion()
```
    Removes the version attribute
    
    Specified by:
    
    removeVersion in interface EjbJarCommonDescriptor<EjbJarDescriptor,EnterpriseBeansType<EjbJarDescriptor>>
    
    Returns:
    
    the current instance of EjbJarDescriptor
  - metadataComplete
```
EjbJarDescriptor metadataComplete(Boolean metadataComplete)
```
    Sets the metadata-complete attribute
    
    Specified by:
    
    metadataComplete in interface EjbJarCommonDescriptor<EjbJarDescriptor,EnterpriseBeansType<EjbJarDescriptor>>
    
    Parameters:
    
    metadataComplete - the value for the attribute metadata-complete
    
    Returns:
    
    the current instance of EjbJarDescriptor
  - isMetadataComplete
```
Boolean isMetadataComplete()
```
    Returns the metadata-complete attribute
    
    Specified by:
    
    isMetadataComplete in interface EjbJarCommonDescriptor<EjbJarDescriptor,EnterpriseBeansType<EjbJarDescriptor>>
    
    Returns:
    
    the value defined for the attribute metadata-complete
  - removeMetadataComplete
```
EjbJarDescriptor removeMetadataComplete()
```
    Removes the metadata-complete attribute
    
    Specified by:
    
    removeMetadataComplete in interface EjbJarCommonDescriptor<EjbJarDescriptor,EnterpriseBeansType<EjbJarDescriptor>>
    
    Returns:
    
    the current instance of EjbJarDescriptor
  - id
```
EjbJarDescriptor id(String id)
```
    Sets the id attribute
    
    Specified by:
    
    id in interface EjbJarCommonDescriptor<EjbJarDescriptor,EnterpriseBeansType<EjbJarDescriptor>>
    
    Parameters:
    
    id - the value for the attribute id
    
    Returns:
    
    the current instance of EjbJarDescriptor
  - getId
```
String getId()
```
    Returns the id attribute
    
    Specified by:
    
    getId in interface EjbJarCommonDescriptor<EjbJarDescriptor,EnterpriseBeansType<EjbJarDescriptor>>
    
    Returns:
    
    the value defined for the attribute id
  - removeId
```
EjbJarDescriptor removeId()
```
    Removes the id attribute
    
    Specified by:
    
    removeId in interface EjbJarCommonDescriptor<EjbJarDescriptor,EnterpriseBeansType<EjbJarDescriptor>>
    
    Returns:
    
    the current instance of EjbJarDescriptor

Interface EjbJarDescriptor

Field Summary

Method Summary

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

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

Field Detail

VERSION

Method Detail

description

getAllDescription

removeAllDescription

displayName

getAllDisplayName

removeAllDisplayName

getOrCreateIcon

createIcon

getAllIcon

removeAllIcon

moduleName

getModuleName

removeModuleName

getOrCreateEnterpriseBeans

removeEnterpriseBeans

getOrCreateInterceptors

removeInterceptors

getOrCreateRelationships

removeRelationships

getOrCreateAssemblyDescriptor

removeAssemblyDescriptor

ejbClientJar

getEjbClientJar

removeEjbClientJar

version

getVersion

removeVersion

metadataComplete

isMetadataComplete

removeMetadataComplete

id

getId

removeId