org.jboss.shrinkwrap.descriptor.api.jbossdeployment13

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
DeploymentType<JBossDeploymentStructureDescriptor>	createDeployment() Creates a new deployment element
ModuleType<JBossDeploymentStructureDescriptor>	createModule() Creates a new module element
SubDeploymentType<JBossDeploymentStructureDescriptor>	createSubDeployment() Creates a new sub-deployment element
JBossDeploymentStructureDescriptor	earExclusionsCascadedToSubdeployments(Boolean... values) Creates for all Boolean objects representing ear-exclusions-cascaded-to-subdeployments elements, a new ear-exclusions-cascaded-to-subdeployments element
JBossDeploymentStructureDescriptor	earSubdeploymentsIsolated(Boolean... values) Creates for all Boolean objects representing ear-subdeployments-isolated elements, a new ear-subdeployments-isolated element
List<DeploymentType<JBossDeploymentStructureDescriptor>>	getAllDeployment() Returns all deployment elements
List<Boolean>	getAllEarExclusionsCascadedToSubdeployments() Returns all ear-exclusions-cascaded-to-subdeployments elements
List<Boolean>	getAllEarSubdeploymentsIsolated() Returns all ear-subdeployments-isolated elements
List<ModuleType<JBossDeploymentStructureDescriptor>>	getAllModule() Returns all module elements
List<SubDeploymentType<JBossDeploymentStructureDescriptor>>	getAllSubDeployment() Returns all sub-deployment elements
DeploymentType<JBossDeploymentStructureDescriptor>	getOrCreateDeployment() If not already created, a new deployment element will be created and returned.
ModuleType<JBossDeploymentStructureDescriptor>	getOrCreateModule() If not already created, a new module element will be created and returned.
SubDeploymentType<JBossDeploymentStructureDescriptor>	getOrCreateSubDeployment() If not already created, a new sub-deployment element will be created and returned.
JBossDeploymentStructureDescriptor	removeAllDeployment() Removes all deployment elements
JBossDeploymentStructureDescriptor	removeAllEarExclusionsCascadedToSubdeployments() Removes the ear-exclusions-cascaded-to-subdeployments element
JBossDeploymentStructureDescriptor	removeAllEarSubdeploymentsIsolated() Removes the ear-subdeployments-isolated element
JBossDeploymentStructureDescriptor	removeAllModule() Removes all module elements
JBossDeploymentStructureDescriptor	removeAllSubDeployment() Removes all sub-deployment elements

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... values)

Creates for all Boolean objects representing ear-subdeployments-isolated elements, a new ear-subdeployments-isolated element

Parameters:

values - list of ear-subdeployments-isolated objects

Returns:

the current instance of JBossDeploymentStructureDescriptor

getAllEarSubdeploymentsIsolated

List<Boolean> getAllEarSubdeploymentsIsolated()

Returns all ear-subdeployments-isolated elements

Returns:

list of ear-subdeployments-isolated

removeAllEarSubdeploymentsIsolated

JBossDeploymentStructureDescriptor removeAllEarSubdeploymentsIsolated()

Removes the ear-subdeployments-isolated element

Returns:

the current instance of JBossDeploymentStructureDescriptor

earExclusionsCascadedToSubdeployments

JBossDeploymentStructureDescriptor earExclusionsCascadedToSubdeployments(Boolean... values)

Creates for all Boolean objects representing ear-exclusions-cascaded-to-subdeployments elements, a new ear-exclusions-cascaded-to-subdeployments element

Parameters:

values - list of ear-exclusions-cascaded-to-subdeployments objects

Returns:

the current instance of JBossDeploymentStructureDescriptor

getAllEarExclusionsCascadedToSubdeployments

List<Boolean> getAllEarExclusionsCascadedToSubdeployments()

Returns all ear-exclusions-cascaded-to-subdeployments elements

Returns:

list of ear-exclusions-cascaded-to-subdeployments

removeAllEarExclusionsCascadedToSubdeployments

JBossDeploymentStructureDescriptor removeAllEarExclusionsCascadedToSubdeployments()

Removes the ear-exclusions-cascaded-to-subdeployments element

Returns:

the current instance of JBossDeploymentStructureDescriptor

getOrCreateDeployment

DeploymentType<JBossDeploymentStructureDescriptor> getOrCreateDeployment()

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

Returns:

the instance defined for the element deployment

createDeployment

DeploymentType<JBossDeploymentStructureDescriptor> createDeployment()

Creates a new deployment element

Returns:

the new created instance of DeploymentType

getAllDeployment

List<DeploymentType<JBossDeploymentStructureDescriptor>> getAllDeployment()

Returns all deployment elements

Returns:

list of deployment

removeAllDeployment

JBossDeploymentStructureDescriptor removeAllDeployment()

Removes all deployment elements

Returns:

the current instance of DeploymentType

getOrCreateSubDeployment

SubDeploymentType<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

SubDeploymentType<JBossDeploymentStructureDescriptor> createSubDeployment()

Creates a new sub-deployment element

Returns:

the new created instance of SubDeploymentType

getAllSubDeployment

List<SubDeploymentType<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 SubDeploymentType

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