org.netbeans.modules.web.spi.webmodule
Interface WebModuleImplementation2

public interface WebModuleImplementation2

SPI for WebModule.

See Also:

WebModuleFactory

Field Summary

static String	PROPERTY_DOCUMENT_BASE
static String	PROPERTY_WEB_INF

Method Summary

void	addPropertyChangeListener(PropertyChangeListener listener) Add propertty change listener.
String	getContextPath() Returns the context path of the web module.
FileObject	getDeploymentDescriptor() Returns the deployment descriptor (web.xml file) of the web module.
FileObject	getDocumentBase() Returns the folder that contains sources of the static documents for the web module (html, JSPs, etc.).
org.netbeans.api.j2ee.core.Profile	getJ2eeProfile()
FileObject[]	getJavaSources() Deprecated. This method is deprecated, because its return values does not contain enough information about the source roots. Source roots are usually implemented by a org.netbeans.api.project.SourceGroup, which is more than just a container for a FileObject.
MetadataModel<WebAppMetadata>	getMetadataModel() Returns a model describing the metadata of this web module (servlets, resources, etc.).
FileObject	getWebInf() WEB-INF folder for the web module.
void	removePropertyChangeListener(PropertyChangeListener listener) Remove propertty change listener.

Field Detail

PROPERTY_DOCUMENT_BASE

static final String PROPERTY_DOCUMENT_BASE

Since:

org.netbeans.api.web.webmodule/1 1.16

See Also:

Constant Field Values

PROPERTY_WEB_INF

static final String PROPERTY_WEB_INF

Since:

org.netbeans.api.web.webmodule/1 1.16

See Also:

Constant Field Values

Method Detail

getDocumentBase

FileObject getDocumentBase()

Returns the folder that contains sources of the static documents for the web module (html, JSPs, etc.).

Returns:

the static documents folder; can be null.

getContextPath

String getContextPath()

Returns the context path of the web module.

Returns:

the context path; can be null.

getJ2eeProfile

org.netbeans.api.j2ee.core.Profile getJ2eeProfile()

getWebInf

FileObject getWebInf()

WEB-INF folder for the web module.

The WEB-INF folder would typically be a child of the folder returned by getDocumentBase() but does not need to be.

Returns:

the FileObject; might be null

getDeploymentDescriptor

FileObject getDeploymentDescriptor()

Returns the deployment descriptor (web.xml file) of the web module.

The web.xml file would typically be a child of the folder returned by getWebInf() but does not need to be.

Returns:

the web.xml file; can be null.

getJavaSources

@Deprecated
FileObject[] getJavaSources()

Deprecated. This method is deprecated, because its return values does not contain enough information about the source roots. Source roots are usually implemented by a org.netbeans.api.project.SourceGroup, which is more than just a container for a FileObject.

Returns the Java source roots associated with the web module.

Note that not all the java source roots in the project (e.g. in a freeform project) belong to the web module.

Returns:

this web module's Java source roots; never null.

getMetadataModel

MetadataModel<WebAppMetadata> getMetadataModel()

Returns a model describing the metadata of this web module (servlets, resources, etc.).

Returns:

this web module's metadata model; never null.

addPropertyChangeListener

void addPropertyChangeListener(PropertyChangeListener listener)

Add propertty change listener.

Since:

org.netbeans.api.web.webmodule/1 1.16

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener listener)

Remove propertty change listener.

Since:

org.netbeans.api.web.webmodule/1 1.16