oracle.jdeveloper.model

Class PathsConfiguration

java.lang.Object

oracle.javatools.data.HashStructureAdapter

oracle.jdeveloper.model.PathsConfiguration

public class PathsConfiguration
extends HashStructureAdapter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATA_KEY
static java.lang.String	JAVA_CONTENT_SET_KEY
static java.lang.String	JAVA_CONTENT_SET_LOCAL_KEY
static java.lang.String	PROJECT_SOURCEPATH

Fields inherited from class oracle.javatools.data.HashStructureAdapter

_hash

Method Summary

Methods

Modifier and Type	Method and Description
static void	addSupportProvider(TechnologySpecificSupportProvider provider)
URLPath	getClassPath()
static Project[]	getDependentProjects(Context context) This gets the list of dependent projects for the project in the context.
static Project[]	getDependentProjects(Project deepestProject) This gets the list of dependent projects for the project in the context.
URLPath	getDocPath()
URLPath	getEndorsedStandardsClassPath() Get the classpath for Endorsed Standards Overrides.
URLPath	getEndorsedStandardsDirectories() Get the directory path for Endorsed Standards Overrides.
URLPath	getEndorsedStandardsDocPath() Get the doc path for the classes on the Endorsed Standards Overrides.
URLPath	getEndorsedStandardsSourcePath() Get the source path for the classes on the Endorsed Standards Overrides.
static PathsConfiguration	getInstance(Project project) Retrieves an instance of PathsConfiguration for the specified project.
static PathsConfiguration	getInstance(Project project, PropertyStorage propertyData)
ContentSet	getJavaContentSet()
URLPath	getProjectSourcePath()
URLPath	getRunClassPath()
URLPath	getRunClassPath(boolean onlyDeployLibs)
URLPath	getRunClassPath(boolean onlyDeployLibs, boolean onlyStaticLibs) The runclasspath of the paths configuration.
URLPath	getSourcePath()
static java.util.List<TechnologySpecificSupportProvider>	getSupportProviders()
static java.net.URL	getURLForPackage(java.lang.String packageName, Context context) Determines the appropriate directory URL for a given package name.
boolean	setProjectSourcePath(URLPath urlPath)

Methods inherited from class oracle.javatools.data.HashStructureAdapter

addStructureChangeListener, containsKey, copyTo, copyToImpl, equals, equalsImpl, findOrCreate, forcedCopyTo, getHashStructure, removeStructureChangeListener, useObjectEquals

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

JAVA_CONTENT_SET_LOCAL_KEY

public static final java.lang.String JAVA_CONTENT_SET_LOCAL_KEY

See Also:

Constant Field Values

JAVA_CONTENT_SET_KEY

public static final java.lang.String JAVA_CONTENT_SET_KEY

PROJECT_SOURCEPATH

public static final java.lang.String PROJECT_SOURCEPATH

See Also:

Constant Field Values

Method Detail

getInstance

public static PathsConfiguration getInstance(Project project)

Retrieves an instance of PathsConfiguration 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 PathsConfiguration instance for manipulating the settings

getInstance

public static PathsConfiguration getInstance(Project project,
                             PropertyStorage propertyData)

getJavaContentSet

public ContentSet getJavaContentSet()

getProjectSourcePath

public URLPath getProjectSourcePath()

Returns:

The user defined project source path. This path does not include the dependencies, libraries, nor any other source path. In general, the source path indicates where the files associated with this project can be found on a file system.

This delegates to getJavaContentSet().getAllRootDirs()

setProjectSourcePath

public boolean setProjectSourcePath(URLPath urlPath)

getSourcePath

public URLPath getSourcePath()

Returns:

The full project source path. This path includes the user defined source path, the source path of the projects this project depends on, the libraries source path, and the jdk source path.

getClassPath

public URLPath getClassPath()

getRunClassPath

public URLPath getRunClassPath()

getRunClassPath

public URLPath getRunClassPath(boolean onlyDeployLibs)

getRunClassPath

public URLPath getRunClassPath(boolean onlyDeployLibs,
                      boolean onlyStaticLibs)

The runclasspath of the paths configuration. The boolean parameters allow for tweaking of the URLPath returned.

Parameters:

onlyDeployLibs - whether only deploy libs are looked at

onlyStaticLibs - whether only static libs are looked at

Returns:

the URLPath

getDocPath

public URLPath getDocPath()

getEndorsedStandardsDirectories

public URLPath getEndorsedStandardsDirectories()

Get the directory path for Endorsed Standards Overrides. This is the set of directories that should be searched for JAR files containing endorsed standards overrides JAR files.

Returns:

the endorsed standards overrides directory path.

Since:

12.1.1

See Also:

Java Endorsed Standards Overrides Mechanism

getEndorsedStandardsClassPath

public URLPath getEndorsedStandardsClassPath()

Get the classpath for Endorsed Standards Overrides. This classpath is derived from the directory path returned by getEndorsedStandardsDirectories(). It contains the JAR files found in those directories.

Returns:

the endorsed standards overrides classpath

Since:

12.1.1

See Also:

Java Endorsed Standards Overrides Mechanism

getEndorsedStandardsSourcePath

public URLPath getEndorsedStandardsSourcePath()

Get the source path for the classes on the Endorsed Standards Overrides.

Returns:

the source path for Endorsed Standards Overrides

Since:

12.1.1

See Also:

getEndorsedStandardsDirectories(), getEndorsedStandardsClassPath()

getEndorsedStandardsDocPath

public URLPath getEndorsedStandardsDocPath()

Get the doc path for the classes on the Endorsed Standards Overrides.

Returns:

the doc path for Endorsed Standards Overrides

Since:

12.1.1

See Also:

getEndorsedStandardsDirectories(), getEndorsedStandardsClassPath()

addSupportProvider

public static void addSupportProvider(TechnologySpecificSupportProvider provider)

getSupportProviders

public static java.util.List<TechnologySpecificSupportProvider> getSupportProviders()

getURLForPackage

public static java.net.URL getURLForPackage(java.lang.String packageName,
                            Context context)

Determines the appropriate directory URL for a given package name. If the directory already exists in a root of the content set then that directory is returned unless there are multiple matches. If there are multiple matches or no matches, then UI is provided to let the user select the directory. If the project set in the context is dependent on other projects, those other projects will be searched for that package in their content sets as well.

Parameters:

packageName - the package name

context - the Context to search

getDependentProjects

public static Project[] getDependentProjects(Context context)

This gets the list of dependent projects for the project in the context. The project in the context itself is removed from the list of dependents.

Parameters:

context -

Returns:

getDependentProjects

public static Project[] getDependentProjects(Project deepestProject)

This gets the list of dependent projects for the project in the context. The project in the context itself is removed from the list of dependents.

Parameters:

deepestProject -

Returns: