oracle.jdeveloper.model

Class JProjectLibraries

java.lang.Object

oracle.javatools.data.HashStructureAdapter

oracle.jdeveloper.model.JProjectLibraries

public class JProjectLibraries
extends HashStructureAdapter

JProjectLibraries is the means by which JDK and JLibrary information may be stored and retrieved from a given PropertyStorage object.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATA_KEY Key for identifying JProjectLibraries table in HashStructure
static java.lang.String	EXPORTS HashStructure key for exported JLibrary references
static java.lang.String	JDK_NAME HashStructure key for JDK reference
static java.lang.String	LIB_LIST HashStructure key for internal Library definitions
static java.lang.String	LIBRARIES HashStructure key for JLibrary references
static java.lang.String	MODULE_PATH_LIBRARIES HashStructure key for module path libraries.
static java.lang.String	OVERRIDE_APP_LIBS HashStructure key for library precedence.

Fields inherited from class oracle.javatools.data.HashStructureAdapter

_hash

Constructor Summary

Constructors

Constructor and Description
JProjectLibraries(HashStructure hash) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	addLibrary(java.lang.Object id) Add an exported JLibrary identified by an ID to the list of referenced JLibrary instances.
boolean	addLibrary(java.lang.Object id, boolean export) Add a JLibrary identified by an ID to the list of referenced JLibrary instances.
boolean	addLibrary(java.lang.Object id, boolean isExported, boolean isModulePathLibrary) Add a JLibrary identified by an ID to the list of referenced JLibrary instances.
void	clearLibraries() Remove all libraries including exported and module path libraries.
JLibrary[]	getClassPathLibraries() Get an array of all class path JLibrary instances.
JLibrary[]	getExports() Get an array of all exported JLibrary instances.
static JProjectLibraries	getInstance(PropertyStorage prj) Get an instance of JProjectLibraries rooted in the given PropertyStorage.
JDK	getJDK() Get the referenced JDK, else the default installed JDK.
VersionNumber	getJdkVersionNumber() Get the version number of the JDK.
JLibrary[]	getLibraries() Get an array of all referenced JLibrary instances.
java.lang.String[]	getLibraryList()
JLibrary[]	getModulePathLibraries() Get an array of all module path JLibrary instances.
boolean	getOverrideApplicationLibraries()
JProjectLibraryList	getProjectLibraryList() Get a LibraryList of all internal Library definitions.
boolean	hasExport(java.lang.Object id)
boolean	hasLibrary(java.lang.Object id)
boolean	hasModulePathLibrary(java.lang.Object id)
boolean	removeLibrary(java.lang.Object id) Remove a JLibrary identified by an ID from the list of referenced JLibrary instances.
JDK	resolveJDK(java.lang.Object id) Resolve a JDK ID to the associated JDK.
JLibrary	resolveLibrary(java.lang.Object id) Resolve a JLibrary ID to the associated JLibrary.
void	setExports(JLibrary[] exports) Set the array of all exported JLibrary instances.
void	setJDK(JDK jdk) Set the referenced JDK.
void	setLibraries(JLibrary[] newLibs) Set the array of all referenced JLibrary instances.
void	setModulePathLibraries(JLibrary[] modulePathLibraries) Set the array of all module path JLibrary instances.
void	setOverrideApplicationLibraries(boolean override)
void	setProjectLibraryList(JProjectLibraryList newList) Set the LibraryList of all internal Library definitions.

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

Key for identifying JProjectLibraries table in HashStructure

See Also:

Constant Field Values

JDK_NAME

public static final java.lang.String JDK_NAME

HashStructure key for JDK reference

See Also:

Constant Field Values

LIBRARIES

public static final java.lang.String LIBRARIES

HashStructure key for JLibrary references

See Also:

Constant Field Values

LIB_LIST

public static final java.lang.String LIB_LIST

HashStructure key for internal Library definitions

See Also:

Constant Field Values

EXPORTS

public static final java.lang.String EXPORTS

HashStructure key for exported JLibrary references

See Also:

Constant Field Values

MODULE_PATH_LIBRARIES

public static final java.lang.String MODULE_PATH_LIBRARIES

HashStructure key for module path libraries.

See Also:

Constant Field Values

OVERRIDE_APP_LIBS

public static final java.lang.String OVERRIDE_APP_LIBS

HashStructure key for library precedence.

See Also:

Constant Field Values

Constructor Detail

JProjectLibraries

public JProjectLibraries(HashStructure hash)

Constructor.

Parameters:

hash - HashStructure in which to read/write values.

Method Detail

getInstance

public static JProjectLibraries getInstance(PropertyStorage prj)

Get an instance of JProjectLibraries rooted in the given PropertyStorage.

Parameters:

prj - the PropertyStorage in which to establish a HashStructure.

Returns:

a new JProjectLibraries instance.

getJDK

public JDK getJDK()

Get the referenced JDK, else the default installed JDK.

Returns:

a JDK.

setJDK

public void setJDK(JDK jdk)

Set the referenced JDK.

Parameters:

jdk - the JDK for which a reference is to be persisted.

getJdkVersionNumber

public VersionNumber getJdkVersionNumber()

Get the version number of the JDK.

Returns:

the JDK version.

getLibraryList

public java.lang.String[] getLibraryList()

getLibraries

public JLibrary[] getLibraries()

Get an array of all referenced JLibrary instances. This will include JLibrary instances for the class path and for the module path.

Returns:

an array of JLibrary.

See Also:

getClassPathLibraries(), getModulePathLibraries()

hasLibrary

public boolean hasLibrary(java.lang.Object id)

Parameters:

id - the ID of a JLibrary.

Returns:

whether the list of libraries contains this library id

setLibraries

public void setLibraries(JLibrary[] newLibs)

Set the array of all referenced JLibrary instances. This method is used internally. Outside callers should use addLibrary(Object,boolean,boolean) and removeLibrary(Object) instead for updating library lists. When using this method, the caller is responsible for calling setModulePathLibraries(JLibrary[]) and setExports(JLibrary[]) as appropriate to keep the lists in sync.

Parameters:

newLibs - an array of JLibrary to be referred to.

getExports

public JLibrary[] getExports()

Get an array of all exported JLibrary instances. This will include JLibrary instances for the class path and for the module path.

Returns:

an array of JLibrary.

hasExport

public boolean hasExport(java.lang.Object id)

Parameters:

id - the ID of a JLibrary.

Returns:

whether the list of exports contains this library id

setExports

public void setExports(JLibrary[] exports)

Set the array of all exported JLibrary instances. This method is used internally. Outside callers should use addLibrary(Object,boolean,boolean) and removeLibrary(Object) instead for updating library lists. When using this method, the caller is responsible for calling setLibraries(JLibrary[]) and setModulePathLibraries(JLibrary[]) as appropriate to keep the lists in sync.

Parameters:

exports - an array of JLibrary to be exported.

getModulePathLibraries

public JLibrary[] getModulePathLibraries()

Get an array of all module path JLibrary instances. This will not include any JLibrary instances for the class path

Returns:

an array of JLibrary.

See Also:

getClassPathLibraries(), getLibraries()

hasModulePathLibrary

public boolean hasModulePathLibrary(java.lang.Object id)

Parameters:

id - the ID of a JLibrary.

Returns:

whether the list of module path libraries contains this library id

setModulePathLibraries

public void setModulePathLibraries(JLibrary[] modulePathLibraries)

Set the array of all module path JLibrary instances. This method is used internally. Outside callers should use addLibrary(Object,boolean,boolean) and removeLibrary(Object) instead for updating library lists. When using this method, the caller is responsible for calling setLibraries(JLibrary[]) and setExports(JLibrary[]) as appropriate to keep the lists in sync.

Parameters:

modulePathLibraries - an array of module JLibrary's.

getClassPathLibraries

public JLibrary[] getClassPathLibraries()

Get an array of all class path JLibrary instances. This will not include any JLibrary instances for the module path.

Returns:

an array of JLibrary.

See Also:

getLibraries(), getModulePathLibraries()

getProjectLibraryList

public JProjectLibraryList getProjectLibraryList()

Get a LibraryList of all internal Library definitions.

Returns:

a LibraryList of internal Library definitions.

setProjectLibraryList

public void setProjectLibraryList(JProjectLibraryList newList)

Set the LibraryList of all internal Library definitions.

Parameters:

newList - LibraryList of internal Library definitions.

addLibrary

public boolean addLibrary(java.lang.Object id)

Add an exported JLibrary identified by an ID to the list of referenced JLibrary instances. Functionally equivalent to addLibrary taking true as the second argument.

Parameters:

id - the ID of a JLibrary.

Returns:

true if the associated JLibrary was successfully added, false if id could not be resolved or the associated JLibrary was already included.

addLibrary

public boolean addLibrary(java.lang.Object id,
                          boolean export)

Add a JLibrary identified by an ID to the list of referenced JLibrary instances.

Parameters:

id - the ID of a JLibrary.

export - whether or not the library is exported.

Returns:

true if the associated JLibrary was successfully added, false if id could not be resolved or the associated JLibrary was already included.

addLibrary

public boolean addLibrary(java.lang.Object id,
                          boolean isExported,
                          boolean isModulePathLibrary)

Add a JLibrary identified by an ID to the list of referenced JLibrary instances.

Parameters:

id - the ID of a JLibrary.

isExported - whether or not the library is exported.

isModulePathLibrary - whether or not the library is a module path library which should be put on the module path instead of the class path

Returns:

true if the associated JLibrary was successfully added, false if id could not be resolved or the associated JLibrary was already included.

clearLibraries

public void clearLibraries()

Remove all libraries including exported and module path libraries.

removeLibrary

public boolean removeLibrary(java.lang.Object id)

Remove a JLibrary identified by an ID from the list of referenced JLibrary instances.

Parameters:

id - the ID of a JLibrary.

Returns:

true if the associated JLibrary was successfully removed, false if id could not be resolved or the associated JLibrary was not present.

resolveLibrary

public JLibrary resolveLibrary(java.lang.Object id)

Resolve a JLibrary ID to the associated JLibrary.

Parameters:

id - the ID of the JLibrary to locate.

Returns:

a JLibrary associated with the given ID.

resolveJDK

public JDK resolveJDK(java.lang.Object id)

Resolve a JDK ID to the associated JDK.

Parameters:

id - the ID of the JDK to locate.

Returns:

a JDK associated with the given ID.

getOverrideApplicationLibraries

public boolean getOverrideApplicationLibraries()

setOverrideApplicationLibraries

public void setOverrideApplicationLibraries(boolean override)