Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.3.0)

E17493-04


oracle.jdeveloper.model
Class JProjectLibraries

java.lang.Object
  extended by oracle.javatools.data.HashStructureAdapter
      extended by 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
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 OVERRIDE_APP_LIBS
          HashStructure key for library precedence.

 

Fields inherited from class oracle.javatools.data.HashStructureAdapter
_hash

 

Constructor Summary
JProjectLibraries(HashStructure hash)
          Constructor.

 

Method Summary
 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.
 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()
           
 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 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 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

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.
Returns:
an array of JLibrary.

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.
Parameters:
newLibs - an array of JLibrary to be referred to.

getExports

public JLibrary[] getExports()
Get an array of all exported JLibrary instances.
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.
Parameters:
exports - an array of JLibrary to be exported.

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.

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)

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.3.0)

E17493-04


Copyright © 1997, 2012, Oracle. All rights reserved.