oracle.jdeveloper.model
Class J2eeSettings

java.lang.Object
  oracle.javatools.data.HashStructureAdapter
      oracle.jdeveloper.model.J2eeSettings

public class J2eeSettings

extends oracle.javatools.data.HashStructureAdapter

Settings object for storing the settings associated with a J2EE project. JDeveloper stores its settings in nested structures within the Project file. The J2eeSettings class pulls the values associated with its properties from the file as needed.

Since:

10.1.3

Field Summary

static java.lang.String	DATA_KEY
static java.lang.String	HTML_SOURCE_ROOT
static java.lang.String	WEB_CONTENT_SET_KEY The key that identifies the web content set.
static java.lang.String	WEB_CONTENT_SET_LOCAL_KEY

Fields inherited from class oracle.javatools.data.HashStructureAdapter

_hash

Method Summary

static void	addCompilableJspType(java.lang.Class jspCompilableType) Registers the specified Class as representing a compilable JSP type.
static void	addJspType(java.lang.Class jspType) Registers the specified Class as representing a JSP type.
ContentSet	getHtmlContentSet()
java.net.URL	getHtmlRootDirectory() Retrieves the HTML root directory.
static J2eeSettings	getInstance(Project project) Retrieves an instance of J2eeSettings for the specified project.
static J2eeSettings	getInstance(Project project, oracle.javatools.data.PropertyStorage propertyData)
java.lang.String	getJ2eeWebAppName() Retrieves the WebApp name.
java.lang.String	getJ2eeWebContextRoot() Retrieves the default context root to use with the project.
java.lang.String	getJ2eeWebContextRoot(boolean forceSlash) Retrieves the default context root with an optionally required forward slash.
static boolean	isCompilableJsp(java.lang.String name) Returns true if the specified name represents some kind of compilable JSP.
static boolean	isJsp(java.lang.String name) Returns true if the specified name represents some kind of JSP, JSP fragment, JSP tag node, etc.
void	setHtmlRootDirectory(java.net.URL root) Sets the HTML root directory.
void	setJ2eeWebAppName(java.lang.String j2eeWebAppName) Sets the WebApp name.
void	setJ2eeWebContextRoot(java.lang.String j2eeWebContextRoot) Sets the default context root.

Methods inherited from class oracle.javatools.data.HashStructureAdapter

containsKey, copyTo, copyToImpl, equals, equalsImpl, findOrCreate

Methods inherited from class java.lang.Object

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

Field Detail

DATA_KEY

public static final java.lang.String DATA_KEY

WEB_CONTENT_SET_LOCAL_KEY

public static final java.lang.String WEB_CONTENT_SET_LOCAL_KEY

See Also:

Constant Field Values

WEB_CONTENT_SET_KEY

public static final java.lang.String WEB_CONTENT_SET_KEY

The key that identifies the web content set.

HTML_SOURCE_ROOT

public static final java.lang.String HTML_SOURCE_ROOT

See Also:

Constant Field Values

Method Detail

getInstance

public static J2eeSettings getInstance(Project project)

Retrieves an instance of J2eeSettings for the specified project. The contents of the Project file will be used to initialize the state of this settings object.

Parameters:

project - the Project containing the settings

Returns:

a new J2eeSettings instance for manipulating the settings

getInstance

public static J2eeSettings getInstance(Project project,
                                       oracle.javatools.data.PropertyStorage propertyData)

getHtmlRootDirectory

public java.net.URL getHtmlRootDirectory()

Retrieves the HTML root directory. The HTML root directory is used as the root for all web files (HTML, JSP, etc).

Returns:

a URL specifying the location of the HTML root directory

setHtmlRootDirectory

public void setHtmlRootDirectory(java.net.URL root)

Sets the HTML root directory. The HTML root directory is used as the root for all web files (HTML, JSP, etc).

Parameters:

root - the URL specifying the location of the HTML root directory

getHtmlContentSet

public ContentSet getHtmlContentSet()

getJ2eeWebAppName

public java.lang.String getJ2eeWebAppName()

Retrieves the WebApp name. The WebApp name is the default name used when creating web applications in the containing project or when running the project files in the embedded app server.

Returns:

the default WebApp name for the project

setJ2eeWebAppName

public void setJ2eeWebAppName(java.lang.String j2eeWebAppName)

Sets the WebApp name. The WebApp name is the default name used when creating web applications in the containing project or when running the project files in the embedded app server.

Parameters:

j2eeWebAppName - the default WebApp name for the project

getJ2eeWebContextRoot

public java.lang.String getJ2eeWebContextRoot()

Retrieves the default context root to use with the project.

Returns:

the default context root

getJ2eeWebContextRoot

public java.lang.String getJ2eeWebContextRoot(boolean forceSlash)

Retrieves the default context root with an optionally required forward slash.

Parameters:

forceSlash - whether the context root should be forced to start with a forward slash

Returns:

the default context root

setJ2eeWebContextRoot

public void setJ2eeWebContextRoot(java.lang.String j2eeWebContextRoot)

Sets the default context root.

Parameters:

j2eeWebContextRoot - the default context root for the project

isJsp

public static boolean isJsp(java.lang.String name)

Returns true if the specified name represents some kind of JSP, JSP fragment, JSP tag node, etc.

addJspType

public static void addJspType(java.lang.Class jspType)

Registers the specified Class as representing a JSP type.

isCompilableJsp

public static boolean isCompilableJsp(java.lang.String name)

Returns true if the specified name represents some kind of compilable JSP.

addCompilableJspType

public static void addCompilableJspType(java.lang.Class jspCompilableType)

Registers the specified Class as representing a compilable JSP type.