public final class LibraryLocation extends Object
Clients may instantiate this class.
Constructor and Description |
---|
LibraryLocation(IPath libraryPath,
IPath sourcePath,
IPath packageRoot)
Creates a new library location.
|
LibraryLocation(IPath libraryPath,
IPath sourcePath,
IPath packageRoot,
URL javadocLocation)
Creates a new library location.
|
LibraryLocation(IPath libraryPath,
IPath sourcePath,
IPath packageRoot,
URL javadocLocation,
URL indexLocation)
Creates a new library location.
|
LibraryLocation(IPath libraryPath,
IPath sourcePath,
IPath packageRoot,
URL javadocLocation,
URL indexLocation,
IPath externalAnnotations)
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(Object obj) |
IPath |
getExternalAnnotationsPath()
Return the JRE library external annotations location.
|
URL |
getIndexLocation()
Returns the index location associated with this library location.
|
URL |
getJavadocLocation()
Returns the Javadoc 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() |
void |
setIndexLocation(URL indexLoc)
Sets the index location to the given
URL . |
void |
setSystemLibrarySource(IPath source)
Sets the JRE library source zip location.
|
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)IllegalArgumentException
- If the library path is null
.public LibraryLocation(IPath libraryPath, IPath sourcePath, IPath packageRoot, 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 javadoc for library
IllegalArgumentException
- If the library path is null
.public LibraryLocation(IPath libraryPath, IPath sourcePath, IPath packageRoot, URL javadocLocation, URL indexLocation)
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 javadoc for library
indexLocation
- The location of the index for library
IllegalArgumentException
- If the library path is null
.public LibraryLocation(IPath libraryPath, IPath sourcePath, IPath packageRoot, URL javadocLocation, URL indexLocation, IPath externalAnnotations)
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 javadoc for library
indexLocation
- The location of the index for library
externalAnnotations
- The file or directory containing external annotations, or null
if not applicable.IllegalArgumentException
- If the library path is null
.public IPath getSystemLibraryPath()
public IPath getSystemLibrarySourcePath()
public IPath getExternalAnnotationsPath()
public IPath getPackageRootPath()
public URL getJavadocLocation()
URL
pointing to the Javadoc location associated with
this Library location, or null
if nonepublic URL getIndexLocation()
URL
pointing to the index location associated with
this Library location, or null
if noneprotected boolean equals(IPath path1, IPath path2)
null
.path1
- path to be comparedpath2
- path to be comparedpublic void setSystemLibrarySource(IPath source)
source
- the source to set
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.