javax.enterprise.deploy.model
Interface DDBeanRoot
- DDBean
public interface DDBeanRoot
An interface that represents the root of a standard deployment descriptor.
A DDBeanRoot is a type of DDBean.
getDDBeanRootVersion
public String getDDBeanRootVersion()
A convenience method to return the version number of an
XML instance document. This method is replacing the
method DeployableObject.getModuleDTDVersion, because
it returns the version number of any J2EE XML instance document
- a string that is the version number of the XML instance document.
Null is returned if no version number can be found.
A module's deployment descriptor file always contains
a document type identifier, DOCTYPE. The DOCTYPE statement
contains the module DTD version number in the label of the
statement.
The format of the DOCTYPE statement is:
<!DOCTYPE root_element PUBLIC "-//organization//label//language" "location">
An example J2EE deployment descriptor DOCTYPE statement is:
<!DOCTYPE application-client PUBLIC
"-//Sun Microsystems, Inc.//DTD J2EE Application Client 1.3//EN"
"http://java.sun.com/dtd/application-client_1_3.dtd">
In this example the label is, "DTD J2EE Application Client 1.3",
and the DTD version number is 1.3. A call to getModuleDTDVersion
would return a string containing, "1.3".
getDeployableObject
public DeployableObject getDeployableObject()
Return the containing DeployableObject
- The DeployableObject that contains this deployment descriptor
getFilename
public String getFilename()
Returns the filename relative to the root of the module of the XML instance document this
DDBeanRoot represents.
- String the filename relative to the root of the module
getModuleDTDVersion
public String getModuleDTDVersion()
A convenience method to return the DTD version number. The DeployableObject has this information.
Note: the method getDDBeanRootVersion() is preferred to this method.
- a string containing the DTD version number
getType
public ModuleType getType()
Return the ModuleType of deployment descriptor.
- The ModuleType of deployment descriptor
getXpath
public String getXpath()
Return the XPath for this standard bean. The root XPath is "/".
- getXpath in interface DDBean
- "/" this is the root standard bean.