org.jboss.shrinkwrap.descriptor.api.batchXML10

Interface BatchXMLDescriptor

All Superinterfaces:

BatchXMLCommonDescriptor<BatchXMLDescriptor,BatchArtifactRef<BatchXMLDescriptor>>, Descriptor, DescriptorNamespace<BatchXMLDescriptor>

public interface BatchXMLDescriptor
extends Descriptor, DescriptorNamespace<BatchXMLDescriptor>, BatchXMLCommonDescriptor<BatchXMLDescriptor,BatchArtifactRef<BatchXMLDescriptor>>

This deployment descriptor provides the functionalities as described in the specification

Example:

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

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

Modifier and Type	Method and Description
BatchArtifactRef<BatchXMLDescriptor>	createRef() Creates a new ref element
List<BatchArtifactRef<BatchXMLDescriptor>>	getAllRef() Returns all ref elements
BatchArtifactRef<BatchXMLDescriptor>	getOrCreateRef() If not already created, a new ref element will be created and returned.
BatchXMLDescriptor	removeAllRef() Removes all ref elements

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

Method Detail

getOrCreateRef

BatchArtifactRef<BatchXMLDescriptor> getOrCreateRef()

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

Returns:

the instance defined for the element ref

createRef

BatchArtifactRef<BatchXMLDescriptor> createRef()

Creates a new ref element

Returns:

the new created instance of BatchArtifactRef

getAllRef

List<BatchArtifactRef<BatchXMLDescriptor>> getAllRef()

Returns all ref elements

Returns:

list of ref

removeAllRef

BatchXMLDescriptor removeAllRef()

Removes all ref elements

Returns:

the current instance of BatchArtifactRef