org.jboss.shrinkwrap.descriptor.api.jbossmodule13

Interface ModuleDescriptor

All Superinterfaces:

Descriptor, DescriptorNamespace<ModuleDescriptor>

public interface ModuleDescriptor
extends Descriptor, DescriptorNamespace<ModuleDescriptor>

This deployment descriptor provides the functionalities as described in the specification

Example:

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

Author:

Toby Crawley, Andrew Lee Rubinger

Method Summary

Modifier and Type	Method and Description
String	getName() Returns the name attribute
DependenciesType<ModuleDescriptor>	getOrCreateDependencies() If not already created, a new dependencies element with the given value will be created.
FilterType<ModuleDescriptor>	getOrCreateExports() If not already created, a new exports element with the given value will be created.
ClassNameType<ModuleDescriptor>	getOrCreateMainClass() If not already created, a new main-class element with the given value will be created.
PermissionsType<ModuleDescriptor>	getOrCreatePermissions() If not already created, a new permissions element with the given value will be created.
PropertyListType<ModuleDescriptor>	getOrCreateProperties() If not already created, a new properties element with the given value will be created.
ResourcesType<ModuleDescriptor>	getOrCreateResources() If not already created, a new resources element with the given value will be created.
String	getSlot() Returns the slot attribute
ModuleDescriptor	name(String name) Sets the name attribute
ModuleDescriptor	removeDependencies() Removes the dependencies element
ModuleDescriptor	removeExports() Removes the exports element
ModuleDescriptor	removeMainClass() Removes the main-class element
ModuleDescriptor	removeName() Removes the name attribute
ModuleDescriptor	removePermissions() Removes the permissions element
ModuleDescriptor	removeProperties() Removes the properties element
ModuleDescriptor	removeResources() Removes the resources element
ModuleDescriptor	removeSlot() Removes the slot attribute
ModuleDescriptor	slot(String slot) Sets the slot 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

getOrCreateExports

FilterType<ModuleDescriptor> getOrCreateExports()

If not already created, a new exports element with the given value will be created. Otherwise, the existing exports element will be returned.

Returns:

a new or existing instance of FilterType

removeExports

ModuleDescriptor removeExports()

Removes the exports element

Returns:

the current instance of ModuleDescriptor

getOrCreateDependencies

DependenciesType<ModuleDescriptor> getOrCreateDependencies()

If not already created, a new dependencies element with the given value will be created. Otherwise, the existing dependencies element will be returned.

Returns:

a new or existing instance of DependenciesType

removeDependencies

ModuleDescriptor removeDependencies()

Removes the dependencies element

Returns:

the current instance of ModuleDescriptor

getOrCreateResources

ResourcesType<ModuleDescriptor> getOrCreateResources()

If not already created, a new resources element with the given value will be created. Otherwise, the existing resources element will be returned.

Returns:

a new or existing instance of ResourcesType

removeResources

ModuleDescriptor removeResources()

Removes the resources element

Returns:

the current instance of ModuleDescriptor

getOrCreateMainClass

ClassNameType<ModuleDescriptor> getOrCreateMainClass()

If not already created, a new main-class element with the given value will be created. Otherwise, the existing main-class element will be returned.

Returns:

a new or existing instance of ClassNameType

removeMainClass

ModuleDescriptor removeMainClass()

Removes the main-class element

Returns:

the current instance of ModuleDescriptor

getOrCreateProperties

PropertyListType<ModuleDescriptor> getOrCreateProperties()

If not already created, a new properties element with the given value will be created. Otherwise, the existing properties element will be returned.

Returns:

a new or existing instance of PropertyListType

removeProperties

ModuleDescriptor removeProperties()

Removes the properties element

Returns:

the current instance of ModuleDescriptor

getOrCreatePermissions

PermissionsType<ModuleDescriptor> getOrCreatePermissions()

If not already created, a new permissions element with the given value will be created. Otherwise, the existing permissions element will be returned.

Returns:

a new or existing instance of PermissionsType

removePermissions

ModuleDescriptor removePermissions()

Removes the permissions element

Returns:

the current instance of ModuleDescriptor

name

ModuleDescriptor name(String name)

Sets the name attribute

Parameters:

name - the value for the attribute name

Returns:

the current instance of ModuleDescriptor

getName

String getName()

Returns the name attribute

Returns:

the value defined for the attribute name

removeName

ModuleDescriptor removeName()

Removes the name attribute

Returns:

the current instance of ModuleDescriptor

slot

ModuleDescriptor slot(String slot)

Sets the slot attribute

Parameters:

slot - the value for the attribute slot

Returns:

the current instance of ModuleDescriptor

getSlot

String getSlot()

Returns the slot attribute

Returns:

the value defined for the attribute slot

removeSlot

ModuleDescriptor removeSlot()

Removes the slot attribute

Returns:

the current instance of ModuleDescriptor