Top Description Methods
javax.enterprise.deploy.model

public Interface DDBeanRoot

extends DDBean
Imports
javax.enterprise.deploy.shared.ModuleType
An interface that represents the root of a standard deployment descriptor. A DDBeanRoot is a type of DDBean.
Author
gfink

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

a string that is the version number of the XML instance document. Null is returned if no version number can be found.
getDDBeanRootVersion()

Returns the version number of an XML instance document.

public DeployableObject

Returns:

The DeployableObject that contains this deployment descriptor
getDeployableObject()

Return the containing DeployableObject

public String

Returns:

String the filename relative to the root of the module
getFilename()

Returns the filename relative to the root of the module of the XML instance document this DDBeanRoot represents.

public String

Returns:

a string containing the DTD version number This method is being deprecated. Two DD data formats are being used, DTD and XML Schema. DDBeanRoot.getDDBeanRootVersion should be used in its place.
getModuleDTDVersion()

Deprecated As of version 1.1 replaced by DDBeanRoot.getDDBeanRootVersion()
A convenience method to return the DTD version number.
public ModuleType

Returns:

The ModuleType of deployment descriptor
getType()

Return the ModuleType of deployment descriptor.

public String

Returns:

"/" this is the root standard bean.
getXpath()

Redeclares javax.enterprise.deploy.model.DDBean.getXpath.

Return the XPath for this standard bean.
Inherited from javax.enterprise.deploy.model.DDBean:
addXpathListenergetAttributeNamesgetAttributeValuegetChildBeangetIdgetRootgetTextgetTextremoveXpathListener

Method Detail

getDDBeanRootVersionback to summary
public String getDDBeanRootVersion()

Returns the version number of an XML instance document. This method is replacing the methods DDBeanRoot.getModuleDTDVersion and DeployableObject.getModuleDTDVersion. This method returns the version number of any Java EE XML instance document.

Returns:String

a string that is the version number of the XML instance document. Null is returned if no version number can be found.

getDeployableObjectback to summary
public DeployableObject getDeployableObject()

Return the containing DeployableObject

Returns:DeployableObject

The DeployableObject that contains this deployment descriptor

getFilenameback to summary
public String getFilename()

Returns the filename relative to the root of the module of the XML instance document this DDBeanRoot represents.

Returns:String

String the filename relative to the root of the module

getModuleDTDVersionback to summary
public String getModuleDTDVersion()

Deprecated

As of version 1.1 replaced by DDBeanRoot.getDDBeanRootVersion()

A convenience method to return the DTD version number. The DeployableObject has this information.

Returns:String

a string containing the DTD version number This method is being deprecated. Two DD data formats are being used, DTD and XML Schema. DDBeanRoot.getDDBeanRootVersion should be used in its place.

getTypeback to summary
public ModuleType getType()

Return the ModuleType of deployment descriptor.

Returns:ModuleType

The ModuleType of deployment descriptor

getXpathback to summary
public String getXpath()

Redeclares javax.enterprise.deploy.model.DDBean.getXpath.

Return the XPath for this standard bean. The root XPath is "/".

Returns:String

"/" this is the root standard bean.