org.netbeans.modules.j2ee.dd.api.application
Class DDProvider

java.lang.Object
  org.netbeans.modules.j2ee.dd.api.application.DDProvider

public final class DDProvider
extends Object

Provides access to Deployment Descriptor root (Application object)

Method Summary

org.netbeans.modules.schema2beans.BaseBean	getBaseBean(CommonDDBean bean) Convenient method for getting the BaseBean object from CommonDDBean object.
Application	getDDRoot(FileObject fo) Returns the root of deployment descriptor bean graph for given file object.
Application	getDDRoot(InputSource is) Returns the root of deployment descriptor bean graph for java.io.File object.
Application	getDDRootCopy(FileObject fo) Returns the root of deployment descriptor bean graph for given file object.
static DDProvider	getDefault() Accessor method for DDProvider singleton
SAXParseException	parse(FileObject fo)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getDefault

public static DDProvider getDefault()

Accessor method for DDProvider singleton

Returns:

DDProvider object

getDDRoot

public Application getDDRoot(FileObject fo)
                      throws IOException

Returns the root of deployment descriptor bean graph for given file object. The method is useful for clients planning to read only the deployment descriptor or to listen to the changes.

There is no guarantee the return value will contain all the changes which happened in the underlaying file recently due to caching.

Parameters:

fo - FileObject representing the application.xml file

Returns:

Application object - root of the deployment descriptor bean graph

Throws:

IOException

getDDRootCopy

public Application getDDRootCopy(FileObject fo)
                          throws IOException

Returns the root of deployment descriptor bean graph for given file object. The method is useful for clients planning to modify the deployment descriptor. Finally the RootInterface.write(org.openide.filesystems.FileObject) should be used for writing the changes.

Parameters:

fo - FileObject representing the application.xml file

Returns:

Application object - root of the deployment descriptor bean graph

Throws:

IOException

getDDRoot

public Application getDDRoot(InputSource is)
                      throws IOException,
                             SAXException

Returns the root of deployment descriptor bean graph for java.io.File object.

Parameters:

is - source representing the application.xml file

Returns:

Application object - root of the deployment descriptor bean graph

Throws:

IOException

SAXException

getBaseBean

public org.netbeans.modules.schema2beans.BaseBean getBaseBean(CommonDDBean bean)

Convenient method for getting the BaseBean object from CommonDDBean object.

parse

public SAXParseException parse(FileObject fo)
                        throws SAXException,
                               IOException

Throws:

SAXException

IOException