oracle.jdeveloper.model

Class JavaProject

java.lang.Object

oracle.javatools.data.HashStructureAdapter

oracle.jdeveloper.model.JavaProject

public final class JavaProject
extends HashStructureAdapter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASSPATH_PROPERTY
static java.lang.String	DEFAULT_PACKAGE
static java.lang.String	DOCPATH_PROPERTY
static java.lang.String	EXT
static java.lang.String	OUTPUT_DIRECTORY
static java.lang.String	OUTPUT_DIRECTORY_LOCAL_KEY
static java.lang.String	PROJECT_SOURCEPATH_PROPERTY
static java.lang.String	SOURCEPATH_PROPERTY
static int	SRC_PATH_ADD Source path has been added.
static int	SRC_PATH_CANCEL_ADD User indicated that the source path should not be added.
static int	SRC_PATH_EXIST No source path has been added since the source path already exists.
static int	SRC_PATH_NOT_ADDED Source path not added because source path is invalid.

Fields inherited from class oracle.javatools.data.HashStructureAdapter

_hash

Method Summary

Methods

Modifier and Type	Method and Description
void	addToProject(java.util.Collection elements, boolean askToAdd) Adds the collection of elements to the project.
int	addToProjectSourcePath(JavaSourceNode node) Attempts to add the package of the incoming JavaSourceNode to the source path of the project.
int	addToProjectSourcePath(java.net.URL srcURL) Attempts to add the incoming URL to the source path of the project IFF the URL is not on any source path yet.
int	addToProjectSourcePath(java.net.URL srcURL, boolean askToAdd) Attempts to add the incoming URL to the source path of the project IFF the URL is not on any source path yet.
static boolean	askDynamicProjectSourcePathUpdate() Ask the user for permission to update the project source path.
static java.lang.String	generateDefaultPackageName(Project project) Returns a valid package name based on the project name.
static java.lang.String	generateDefaultPackageName(java.lang.String projectName) Returns a valid package name based on the project name.
java.lang.String	getDefaultPackage() Gets the user-specified default package name.
static JavaProject	getInstance(Project project)
static JavaProject	getInstance(Project project, HashStructure hash)
java.lang.String	getMostRecentPackage() Gets the name of the last-used package.
java.net.URL	getOutputDirectory()
ListStructure	getRecentPackages() Gets the list of most-recently used packages.
static void	init() This method should be considered package-protected.
void	setDefaultPackage(java.lang.String defaultPackage) Sets the project's default package.
void	setMostRecentPackage(java.lang.String mostRecentPackage) Sets the name of the last-used package.
void	setOutputDirectory(java.net.URL outputDirectory)
void	setRecentPackages(java.util.List pkgs) Sets the list of most-recently used packages.

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

EXT

public static final java.lang.String EXT

See Also:

Constant Field Values

SOURCEPATH_PROPERTY

public static final java.lang.String SOURCEPATH_PROPERTY

See Also:

Constant Field Values

CLASSPATH_PROPERTY

public static final java.lang.String CLASSPATH_PROPERTY

See Also:

Constant Field Values

PROJECT_SOURCEPATH_PROPERTY

public static final java.lang.String PROJECT_SOURCEPATH_PROPERTY

See Also:

Constant Field Values

DOCPATH_PROPERTY

public static final java.lang.String DOCPATH_PROPERTY

See Also:

Constant Field Values

SRC_PATH_EXIST

public static final int SRC_PATH_EXIST

No source path has been added since the source path already exists.

See Also:

Constant Field Values

SRC_PATH_ADD

public static final int SRC_PATH_ADD

Source path has been added.

See Also:

Constant Field Values

SRC_PATH_CANCEL_ADD

public static final int SRC_PATH_CANCEL_ADD

User indicated that the source path should not be added.

See Also:

Constant Field Values

SRC_PATH_NOT_ADDED

public static final int SRC_PATH_NOT_ADDED

Source path not added because source path is invalid.

See Also:

Constant Field Values

OUTPUT_DIRECTORY_LOCAL_KEY

public static final java.lang.String OUTPUT_DIRECTORY_LOCAL_KEY

See Also:

Constant Field Values

OUTPUT_DIRECTORY

public static final java.lang.String OUTPUT_DIRECTORY

DEFAULT_PACKAGE

public static final java.lang.String DEFAULT_PACKAGE

See Also:

Constant Field Values

Method Detail

getInstance

public static JavaProject getInstance(Project project)

getInstance

public static JavaProject getInstance(Project project,
                      HashStructure hash)

getOutputDirectory

public java.net.URL getOutputDirectory()

setOutputDirectory

public void setOutputDirectory(java.net.URL outputDirectory)

getDefaultPackage

public java.lang.String getDefaultPackage()

Gets the user-specified default package name. This is not necessarily the last-used package.

Returns:

the default package name

See Also:

getMostRecentPackage(), setMostRecentPackage(java.lang.String)

generateDefaultPackageName

public static java.lang.String generateDefaultPackageName(Project project)

Returns a valid package name based on the project name.

Parameters:

project - the project to use to generate the package name

Returns:

a valid package name

generateDefaultPackageName

public static java.lang.String generateDefaultPackageName(java.lang.String projectName)

Returns a valid package name based on the project name.

Parameters:

projectName - a project name

Returns:

a valid package name

setDefaultPackage

public void setDefaultPackage(java.lang.String defaultPackage)

Sets the project's default package. Because this property is stored in the project, calling this method will mark the project dirty. This value should only change as a result of explicit user interaction, for example, the user modifies this value in the Project Properties dialog. To set the last-used package, use setMostRecentPackage(java.lang.String) instead.

Parameters:

defaultPackage - a valid package name

See Also:

getMostRecentPackage(), setMostRecentPackage(java.lang.String), setRecentPackages(java.util.List)

getMostRecentPackage

public java.lang.String getMostRecentPackage()

Gets the name of the last-used package.

Returns:

the package name

setMostRecentPackage

public void setMostRecentPackage(java.lang.String mostRecentPackage)

Sets the name of the last-used package.

Parameters:

mostRecentPackage - the name of the last-used package

getRecentPackages

public ListStructure getRecentPackages()

Gets the list of most-recently used packages.

Returns:

An unsynchronized List that should be synchronized when used. The returned List is "live": any changes made to it write through to the project.

setRecentPackages

public void setRecentPackages(java.util.List pkgs)

Sets the list of most-recently used packages.

Parameters:

pkgs - a list of package names

addToProjectSourcePath

public int addToProjectSourcePath(JavaSourceNode node)

Attempts to add the package of the incoming JavaSourceNode to the source path of the project.

Parameters:

node - A JavaSourceNode which should not be null

Returns:

One of the SRC_PATH_XXX values

addToProjectSourcePath

public int addToProjectSourcePath(java.net.URL srcURL)

Attempts to add the incoming URL to the source path of the project IFF the URL is not on any source path yet. The incoming URL should be an existing directory URL.

Parameters:

srcURL - An existing directory URL representing a source directory

Returns:

One of the SRC_PATH_XXX values

addToProjectSourcePath

public int addToProjectSourcePath(java.net.URL srcURL,
                         boolean askToAdd)

Attempts to add the incoming URL to the source path of the project IFF the URL is not on any source path yet. The incoming URL should be an existing directory URL.

Parameters:

srcURL - An existing directory URL representing a source directory

askToAdd - If true, user will be asked for permission to add to the source path

Returns:

One of the SRC_PATH_XXX values

addToProject

public void addToProject(java.util.Collection elements,
                boolean askToAdd)

Adds the collection of elements to the project. The elements that could not be added to the project are removed from the collection. The ask parameter determines if the user is ever asked whether or not to modify the java source path of the project.

askDynamicProjectSourcePathUpdate

public static boolean askDynamicProjectSourcePathUpdate()

Ask the user for permission to update the project source path.

Returns:

True if the sourcepath can be updated, false otherwise

init

public static void init()

This method should be considered package-protected. Making it public only so it can be called from a class in the same package but in another osgi bundle.