public final class LibraryLocation
extends java.lang.Object
Clients may instantiate this class; it is not intended to be subclassed.
Provisional API: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.Constructor and Description |
---|
LibraryLocation(IPath libraryPath,
IPath sourcePath,
IPath packageRoot)
Creates a new library location.
|
LibraryLocation(IPath libraryPath,
IPath sourcePath,
IPath packageRoot,
java.net.URL javadocLocation)
Creates a new library location.
|
Modifier and Type | Method and Description |
---|---|
protected boolean |
equals(IPath path1,
IPath path2)
Returns whether the given paths are equal - either may be
null . |
boolean |
equals(java.lang.Object obj) |
java.net.URL |
getJavadocLocation()
Returns the jsdoc location associated with this Library location.
|
IPath |
getPackageRootPath()
Returns the path to the default package in the sources zip file
|
IPath |
getSystemLibraryPath()
Returns the JRE library jar location.
|
IPath |
getSystemLibrarySourcePath()
Returns the JRE library source zip location.
|
int |
hashCode() |
public LibraryLocation(IPath libraryPath, IPath sourcePath, IPath packageRoot)
libraryPath
- The location of the JAR containing java.lang.Object
Must not be null
.sourcePath
- The location of the zip file containing the sources for library
Must not be null
(Use Path.EMPTY instead)packageRoot
- The path inside the source
zip file where packages names
begin. If the source for java.lang.Object source is found at
"src/java/lang/Object.java" in the zip file, the
packageRoot should be "src"
Must not be null
. (Use Path.EMPTY or IPath.ROOT)java.lang.IllegalArgumentException
- If the library path is null
.public LibraryLocation(IPath libraryPath, IPath sourcePath, IPath packageRoot, java.net.URL javadocLocation)
libraryPath
- The location of the JAR containing java.lang.Object
Must not be null
.sourcePath
- The location of the zip file containing the sources for library
Must not be null
(Use Path.EMPTY instead)packageRoot
- The path inside the source
zip file where packages names
begin. If the source for java.lang.Object source is found at
"src/java/lang/Object.java" in the zip file, the
packageRoot should be "src"
Must not be null
. (Use Path.EMPTY or IPath.ROOT)javadocLocation
- The location of the jsdoc for library
java.lang.IllegalArgumentException
- If the library path is null
.public IPath getSystemLibraryPath()
public IPath getSystemLibrarySourcePath()
public IPath getPackageRootPath()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
protected boolean equals(IPath path1, IPath path2)
null
.path1
- path to be comparedpath2
- path to be comparedpublic java.net.URL getJavadocLocation()
null
if noneCopyright (c) IBM Corp. and others 2000, 2016. All Rights Reserved.