ApplicationDescriptor (ShrinkWrap Descriptors Aggregator 2.0.0 API)

All Superinterfaces:

ApplicationCommonDescriptor<ApplicationDescriptor,ModuleType<ApplicationDescriptor>,SecurityRoleType<ApplicationDescriptor>>, Descriptor, DescriptorNamespace<ApplicationDescriptor>
```
public interface ApplicationDescriptor
extends Descriptor, DescriptorNamespace<ApplicationDescriptor>, ApplicationCommonDescriptor<ApplicationDescriptor,ModuleType<ApplicationDescriptor>,SecurityRoleType<ApplicationDescriptor>>
```
This deployment descriptor provides the functionalities as described in the specification
Example:
ApplicationDescriptor descriptor = Descriptors.create(ApplicationDescriptor.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<ApplicationDescriptor>`	`createIcon()` Creates a new `icon` element
`ModuleType<ApplicationDescriptor>`	`createModule()` Creates a new `module` element
`SecurityRoleType<ApplicationDescriptor>`	`createSecurityRole()` Creates a new `security-role` 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<String>`	`getAllDescription()` Returns all `description` elements
`List<String>`	`getAllDisplayName()` Returns all `display-name` elements
`List<IconType<ApplicationDescriptor>>`	`getAllIcon()` Returns all `icon` elements
`List<ModuleType<ApplicationDescriptor>>`	`getAllModule()` Returns all `module` elements
`List<SecurityRoleType<ApplicationDescriptor>>`	`getAllSecurityRole()` Returns all `security-role` elements
`String`	`getId()` Returns the `id` attribute
`String`	`getLibraryDirectory()` Returns the `library-directory` element
`IconType<ApplicationDescriptor>`	`getOrCreateIcon()` If not already created, a new `icon` element will be created and returned.
`ModuleType<ApplicationDescriptor>`	`getOrCreateModule()` If not already created, a new `module` element will be created and returned.
`SecurityRoleType<ApplicationDescriptor>`	`getOrCreateSecurityRole()` If not already created, a new `security-role` element will be created and returned.
`String`	`getVersion()` Returns the `version` attribute
`ApplicationDescriptor`	`id(String id)` Sets the `id` attribute
`ApplicationDescriptor`	`libraryDirectory(String libraryDirectory)` Sets the `library-directory` element
`ApplicationDescriptor`	`removeAllDescription()` Removes the `description` element
`ApplicationDescriptor`	`removeAllDisplayName()` Removes the `display-name` element
`ApplicationDescriptor`	`removeAllIcon()` Removes all `icon` elements
`ApplicationDescriptor`	`removeAllModule()` Removes all `module` elements
`ApplicationDescriptor`	`removeAllSecurityRole()` Removes all `security-role` elements
`ApplicationDescriptor`	`removeId()` Removes the `id` 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.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
```
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
  - 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
  - version
```
ApplicationDescriptor version(String version)
```
    Sets the version attribute
    
    Specified by:
    
    version in interface ApplicationCommonDescriptor<ApplicationDescriptor,ModuleType<ApplicationDescriptor>,SecurityRoleType<ApplicationDescriptor>>
    
    Parameters:
    
    version - the value for the attribute version
    
    Returns:
    
    the current instance of ApplicationDescriptor
  - getVersion
```
String getVersion()
```
    Returns the version attribute
    
    Specified by:
    
    getVersion in interface ApplicationCommonDescriptor<ApplicationDescriptor,ModuleType<ApplicationDescriptor>,SecurityRoleType<ApplicationDescriptor>>
    
    Returns:
    
    the value defined for the attribute version
  - removeVersion
```
ApplicationDescriptor removeVersion()
```
    Removes the version attribute
    
    Specified by:
    
    removeVersion in interface ApplicationCommonDescriptor<ApplicationDescriptor,ModuleType<ApplicationDescriptor>,SecurityRoleType<ApplicationDescriptor>>
    
    Returns:
    
    the current instance of ApplicationDescriptor
  - id
```
ApplicationDescriptor id(String id)
```
    Sets the id attribute
    
    Specified by:
    
    id in interface ApplicationCommonDescriptor<ApplicationDescriptor,ModuleType<ApplicationDescriptor>,SecurityRoleType<ApplicationDescriptor>>
    
    Parameters:
    
    id - the value for the attribute id
    
    Returns:
    
    the current instance of ApplicationDescriptor
  - getId
```
String getId()
```
    Returns the id attribute
    
    Specified by:
    
    getId in interface ApplicationCommonDescriptor<ApplicationDescriptor,ModuleType<ApplicationDescriptor>,SecurityRoleType<ApplicationDescriptor>>
    
    Returns:
    
    the value defined for the attribute id
  - removeId
```
ApplicationDescriptor removeId()
```
    Removes the id attribute
    
    Specified by:
    
    removeId in interface ApplicationCommonDescriptor<ApplicationDescriptor,ModuleType<ApplicationDescriptor>,SecurityRoleType<ApplicationDescriptor>>
    
    Returns:
    
    the current instance of ApplicationDescriptor

Interface ApplicationDescriptor

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

getOrCreateModule

createModule

getAllModule

removeAllModule

getOrCreateSecurityRole

createSecurityRole

getAllSecurityRole

removeAllSecurityRole

libraryDirectory

getLibraryDirectory

removeLibraryDirectory

version

getVersion

removeVersion

id

getId

removeId