org.jboss.shrinkwrap.descriptor.api.jbossdeployment10

Interface JBossDeploymentStructureDescriptor

All Superinterfaces:

Descriptor, DescriptorNamespace<JBossDeploymentStructureDescriptor>

public interface JBossDeploymentStructureDescriptor
extends Descriptor, DescriptorNamespace<JBossDeploymentStructureDescriptor>

This deployment descriptor provides the functionalities as described in the specification

Example:

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

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

Modifier and Type	Method and Description
ModuleType<JBossDeploymentStructureDescriptor>	createModule() Creates a new module element
DeploymentType<JBossDeploymentStructureDescriptor>	createSubDeployment() Creates a new sub-deployment element
JBossDeploymentStructureDescriptor	earSubdeploymentsIsolated(Boolean earSubdeploymentsIsolated) Sets the ear-subdeployments-isolated element
List<ModuleType<JBossDeploymentStructureDescriptor>>	getAllModule() Returns all module elements
List<DeploymentType<JBossDeploymentStructureDescriptor>>	getAllSubDeployment() Returns all sub-deployment elements
DeploymentType<JBossDeploymentStructureDescriptor>	getOrCreateDeployment() If not already created, a new deployment element with the given value will be created.
ModuleType<JBossDeploymentStructureDescriptor>	getOrCreateModule() If not already created, a new module element will be created and returned.
DeploymentType<JBossDeploymentStructureDescriptor>	getOrCreateSubDeployment() If not already created, a new sub-deployment element will be created and returned.
Boolean	isEarSubdeploymentsIsolated() Returns the ear-subdeployments-isolated element
JBossDeploymentStructureDescriptor	removeAllModule() Removes all module elements
JBossDeploymentStructureDescriptor	removeAllSubDeployment() Removes all sub-deployment elements
JBossDeploymentStructureDescriptor	removeDeployment() Removes the deployment element
JBossDeploymentStructureDescriptor	removeEarSubdeploymentsIsolated() Removes the ear-subdeployments-isolated element

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

earSubdeploymentsIsolated

JBossDeploymentStructureDescriptor earSubdeploymentsIsolated(Boolean earSubdeploymentsIsolated)

Sets the ear-subdeployments-isolated element

Parameters:

earSubdeploymentsIsolated - the value for the element ear-subdeployments-isolated

Returns:

the current instance of JBossDeploymentStructureDescriptor

isEarSubdeploymentsIsolated

Boolean isEarSubdeploymentsIsolated()

Returns the ear-subdeployments-isolated element

Returns:

the node defined for the element ear-subdeployments-isolated

removeEarSubdeploymentsIsolated

JBossDeploymentStructureDescriptor removeEarSubdeploymentsIsolated()

Removes the ear-subdeployments-isolated element

Returns:

the current instance of JBossDeploymentStructureDescriptor

getOrCreateDeployment

DeploymentType<JBossDeploymentStructureDescriptor> getOrCreateDeployment()

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

Returns:

a new or existing instance of DeploymentType

removeDeployment

JBossDeploymentStructureDescriptor removeDeployment()

Removes the deployment element

Returns:

the current instance of JBossDeploymentStructureDescriptor

getOrCreateSubDeployment

DeploymentType<JBossDeploymentStructureDescriptor> getOrCreateSubDeployment()

If not already created, a new sub-deployment element will be created and returned. Otherwise, the first existing sub-deployment element will be returned.

Returns:

the instance defined for the element sub-deployment

createSubDeployment

DeploymentType<JBossDeploymentStructureDescriptor> createSubDeployment()

Creates a new sub-deployment element

Returns:

the new created instance of DeploymentType

getAllSubDeployment

List<DeploymentType<JBossDeploymentStructureDescriptor>> getAllSubDeployment()

Returns all sub-deployment elements

Returns:

list of sub-deployment

removeAllSubDeployment

JBossDeploymentStructureDescriptor removeAllSubDeployment()

Removes all sub-deployment elements

Returns:

the current instance of DeploymentType

getOrCreateModule

ModuleType<JBossDeploymentStructureDescriptor> 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<JBossDeploymentStructureDescriptor> createModule()

Creates a new module element

Returns:

the new created instance of ModuleType

getAllModule

List<ModuleType<JBossDeploymentStructureDescriptor>> getAllModule()

Returns all module elements

Returns:

list of module

removeAllModule

JBossDeploymentStructureDescriptor removeAllModule()

Removes all module elements

Returns:

the current instance of ModuleType