|
Eclipse JDT Kepler |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jdt.launching.LibraryLocation
public final class LibraryLocation
The location of a library (for example rt.jar).
Clients may instantiate this class.
Constructor Summary | |
---|---|
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. |
|
LibraryLocation(IPath libraryPath,
IPath sourcePath,
IPath packageRoot,
java.net.URL javadocLocation,
java.net.URL indexLocation)
Creates a new library location. |
Method Summary | |
---|---|
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 |
getIndexLocation()
Returns the index location associated with this library location. |
java.net.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(java.net.URL indexLoc)
Sets the index location to the given URL . |
void |
setSystemLibrarySource(IPath source)
Sets the JRE library source zip location. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
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 javadoc for library
java.lang.IllegalArgumentException
- If the library path is null
.public LibraryLocation(IPath libraryPath, IPath sourcePath, IPath packageRoot, java.net.URL javadocLocation, java.net.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
java.lang.IllegalArgumentException
- If the library path is null
.Method Detail |
---|
public IPath getSystemLibraryPath()
public IPath getSystemLibrarySourcePath()
public IPath getPackageRootPath()
public java.net.URL getJavadocLocation()
URL
pointing to the Javadoc location associated with
this Library location, or null
if nonepublic java.net.URL getIndexLocation()
URL
pointing to the index location associated with
this Library location, or null
if nonepublic 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 compared
public void setSystemLibrarySource(IPath source)
source
- the source to setpublic void setIndexLocation(java.net.URL indexLoc)
URL
.
indexLoc
-
|
Eclipse JDT Kepler |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) 2000, 2012 IBM Corporation and others. All rights reserved.