org.codehaus.cargo.module
Interface Descriptor

All Superinterfaces:

java.lang.Cloneable, org.jdom.Parent, java.io.Serializable

All Known Subinterfaces:

J2eeDescriptor, VendorDescriptor, VendorEjbDescriptor, VendorWebAppDescriptor

All Known Implementing Classes:

AbstractDescriptor, ApplicationXml, EjbJarXml, IbmEjbJarBndXmi, IbmWebBndXmi, JBossWebXml, JBossXml, OrionEjbJarXml, OrionWebXml, ResinWebXml, TomcatContextXml, WeblogicEjbJarXml, WeblogicXml, WebXml

public interface Descriptor
extends org.jdom.Parent

Common interface for Deployment Descriptors.

Version:

$Id: Descriptor.java 1705 2008-09-02 13:14:55Z adriana $

Method Summary

org.jdom.Element	addElement(DescriptorTag tag, org.jdom.Element right, org.jdom.Element rootElement) Add an element into the descriptor.
DescriptorType	getDescriptorType() Get the descriptor type for this descriptor.
org.jdom.Document	getDocument()
java.lang.String	getFileName() Returns the file name of this descriptor.
org.jdom.Element	getRootElement()
org.jdom.Element	getTagByIdentifier(DescriptorTag tag, java.lang.String value) Get elements of a particular descriptor tag whose identifier matches the passed parameter.
java.util.List	getTags(DescriptorTag tag) Get tags of a particular type.

Methods inherited from interface org.jdom.Parent

clone, cloneContent, getContent, getContent, getContent, getContentSize, getDescendants, getDescendants, getParent, indexOf, removeContent, removeContent, removeContent, removeContent

Method Detail

getFileName

java.lang.String getFileName()

Returns the file name of this descriptor. For example "web.xml", "weblogic.xml", etc.

Returns:

the file name

getDocument

org.jdom.Document getDocument()

Specified by:

getDocument in interface org.jdom.Parent

Returns:

this descriptor as a document

getRootElement

org.jdom.Element getRootElement()

See Also:

org.jdom.Parent#getRootElement

addElement

org.jdom.Element addElement(DescriptorTag tag,
                            org.jdom.Element right,
                            org.jdom.Element rootElement)

Add an element into the descriptor.

Parameters:

tag - Descriptor Tag

right - Element insert before

rootElement - Parent element

Returns:

The added element

getTagByIdentifier

org.jdom.Element getTagByIdentifier(DescriptorTag tag,
                                    java.lang.String value)

Get elements of a particular descriptor tag whose identifier matches the passed parameter.

Parameters:

tag - tag to search for

value - value for the identifier to match

Returns:

the element that matches

getTags

java.util.List getTags(DescriptorTag tag)

Get tags of a particular type.

Parameters:

tag - type of elements to find

Returns:

list of tags

getDescriptorType

DescriptorType getDescriptorType()

Get the descriptor type for this descriptor.

Returns:

descriptor type.