Top Description Methods
javax.enterprise.deploy.model

public Interface J2eeApplicationObject

extends DeployableObject
Imports
javax.enterprise.deploy.shared.ModuleType

J2eeApplicationObject is an interface that represents a Java EE application (EAR); it maintains a DeployableObject for each module in the archive.

Method Summary

Modifier and TypeMethod and Description
public void
addXpathListener(ModuleType
The type of deployment descriptor to query.
type
,
String
The xpath to listen for.
xpath
,
XpathListener
The listener.
xpl
)

Register a listener for changes in XPath that are related to this deployableObject.

public DDBean[]

Returns:

The list of DDBeans or 'null' of there are no matches.
getChildBean
(ModuleType
The type of deployment descriptor to query.
type
,
String
An XPath string referring to a location in the deployment descriptor
xpath
)

Return a list of DDBean based upon an XPath; all deployment descriptors of the specified type are searched.

public DeployableObject

Returns:

the DeployableObject describing the j2ee module at this uri or 'null' if there is not match.
getDeployableObject
(String
Describes where to get the module from.
uri
)

Return the DeployableObject of the specified URI designator.

public DeployableObject[]

Returns:

the list of DeployableObjects describing the j2ee module at this uri or 'null' if there are no matches.
getDeployableObjects
(ModuleType
The type of module to return.
type
)

Return the all DeployableObjects of the specified type.

public DeployableObject[]

Returns:

the DeployableObject describing the j2ee module at this uri or 'null' if there are no matches.
getDeployableObjects
()

Return the all DeployableObjects in this application.

public String[]

Returns:

the Uris of the contained modules or 'null' if there are no matches.
getModuleUris
(ModuleType
The type of module to return.
type
)

Return the list of URIs of the designated module type.

public String[]

Returns:

the Uris of the contained modules or 'null' if there are no matches.
getModuleUris
()

Return the list of URIs for all modules in the application.

public String[]

Returns:

The text values of this xpath or 'null' if there are no matches.
getText
(ModuleType
The type of deployment descriptor to query.
type
,
String
An xpath string referring to a location in the deployment descriptor
xpath
)

Return the text value from the XPath; search only the deployment descriptors of the specified type.

public void
removeXpathListener(ModuleType
The type of deployment descriptor to query.
type
,
String
he XPath to listen for
xpath
,
XpathListener
The listener
xpl
)

Unregister the listener for an XPath.

Inherited from javax.enterprise.deploy.model.DeployableObject:
entriesgetChildBeangetClassFromScopegetDDBeanRootgetDDBeanRootgetEntrygetModuleDTDVersiongetTextgetType

Method Detail

addXpathListenerback to summary
public void addXpathListener(ModuleType type, String xpath, XpathListener xpl)

Register a listener for changes in XPath that are related to this deployableObject.

Parameters
type:ModuleType

The type of deployment descriptor to query.

xpath:String

The xpath to listen for.

xpl:XpathListener

The listener.

getChildBeanback to summary
public DDBean[] getChildBean(ModuleType type, String xpath)

Return a list of DDBean based upon an XPath; all deployment descriptors of the specified type are searched.

Parameters
type:ModuleType

The type of deployment descriptor to query.

xpath:String

An XPath string referring to a location in the deployment descriptor

Returns:DDBean[]

The list of DDBeans or 'null' of there are no matches.

getDeployableObjectback to summary
public DeployableObject getDeployableObject(String uri)

Return the DeployableObject of the specified URI designator.

Parameters
uri:String

Describes where to get the module from.

Returns:DeployableObject

the DeployableObject describing the j2ee module at this uri or 'null' if there is not match.

getDeployableObjectsback to summary
public DeployableObject[] getDeployableObjects(ModuleType type)

Return the all DeployableObjects of the specified type.

Parameters
type:ModuleType

The type of module to return.

Returns:DeployableObject[]

the list of DeployableObjects describing the j2ee module at this uri or 'null' if there are no matches.

getDeployableObjectsback to summary
public DeployableObject[] getDeployableObjects()

Return the all DeployableObjects in this application.

Returns:DeployableObject[]

the DeployableObject describing the j2ee module at this uri or 'null' if there are no matches.

getModuleUrisback to summary
public String[] getModuleUris(ModuleType type)

Return the list of URIs of the designated module type.

Parameters
type:ModuleType

The type of module to return.

Returns:String[]

the Uris of the contained modules or 'null' if there are no matches.

getModuleUrisback to summary
public String[] getModuleUris()

Return the list of URIs for all modules in the application.

Returns:String[]

the Uris of the contained modules or 'null' if there are no matches.

getTextback to summary
public String[] getText(ModuleType type, String xpath)

Return the text value from the XPath; search only the deployment descriptors of the specified type.

Parameters
type:ModuleType

The type of deployment descriptor to query.

xpath:String

An xpath string referring to a location in the deployment descriptor

Returns:String[]

The text values of this xpath or 'null' if there are no matches.

removeXpathListenerback to summary
public void removeXpathListener(ModuleType type, String xpath, XpathListener xpl)

Unregister the listener for an XPath.

Parameters
type:ModuleType

The type of deployment descriptor to query.

xpath:String

he XPath to listen for

xpl:XpathListener

The listener