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

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

public final class DDProvider
extends Object

Provides access to Deployment Descriptor root (WebApp object)

Method Summary

org.netbeans.modules.schema2beans.BaseBean	getBaseBean(CommonDDBean bean) Deprecated. do not use - temporary workaround that exposes the schema2beans implementation
WebApp	getDDRoot(File f) Returns the root of deployment descriptor bean graph for java.io.File object.
WebApp	getDDRoot(FileObject fo) Gets the root bean graph representing the given web.xml deployment descriptor file.
WebApp	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 WebApp getDDRoot(FileObject fo)
                 throws IOException

Gets the root bean graph representing the given web.xml deployment descriptor file.

Parameters:

fo - the file object representing a web.xml file. Must not be null.

Returns:

the WebApp representing the given fo.

Throws:

IOException - if the given fo could not be read or if parsing it failed.

getDDRootCopy

public WebApp 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 web.xml file

Returns:

WebApp object - root of the deployment descriptor bean graph

Throws:

IOException

getDDRoot

public WebApp getDDRoot(File f)
                 throws IOException,
                        SAXException

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

Parameters:

f - File representing the web.xml file

Returns:

WebApp object - root of the deployment descriptor bean graph

Throws:

IOException

SAXException

getBaseBean

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

Deprecated. do not use - temporary workaround that exposes the schema2beans implementation

Convenient method for getting the BaseBean object from CommonDDBean object. The j2eeserver module needs BaseBean to implement jsr88 API. This is a temporary workaround until the implementation of jsr88 moves into ddapi or the implementation in j2eeserver gets changed.

parse

public SAXParseException parse(FileObject fo)
                        throws SAXException,
                               IOException

Throws:

SAXException

IOException