Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse JDT
Release 3.5

org.eclipse.jdt.launching
Class LibraryLocation

java.lang.Object
  extended by 
org.eclipse.jdt.launching.LibraryLocation

public final class LibraryLocation
extends Object

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, URL javadocLocation)
          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 ( Object obj)
           
  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 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

LibraryLocation

public LibraryLocation(
IPath libraryPath,
                       
IPath sourcePath,
                       
IPath packageRoot)
Creates a new library location.

Parameters:
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)
Throws:
IllegalArgumentException - If the library path is null.

LibraryLocation

public LibraryLocation(
IPath libraryPath,
                       
IPath sourcePath,
                       
IPath packageRoot,
                       
URL javadocLocation)
Creates a new library location.

Parameters:
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
Throws:
IllegalArgumentException - If the library path is null.
Since:
3.1
Method Detail

getSystemLibraryPath

public 
IPath getSystemLibraryPath()
Returns the JRE library jar location.

Returns:
The JRE library jar location.

getSystemLibrarySourcePath

public 
IPath getSystemLibrarySourcePath()
Returns the JRE library source zip location.

Returns:
The JRE library source zip location.

getPackageRootPath

public 
IPath getPackageRootPath()
Returns the path to the default package in the sources zip file

Returns:
The path to the default package in the sources zip file.

getJavadocLocation

public 
URL getJavadocLocation()
Returns the Javadoc location associated with this Library location.

Returns:
a url pointing to the Javadoc location associated with this Library location, or null if none
Since:
3.1

equals

public boolean equals(
Object obj)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

protected boolean equals(
IPath path1,
                         
IPath path2)
Returns whether the given paths are equal - either may be null.

Parameters:
path1 - path to be compared
path2 - path to be compared
Returns:
whether the given paths are equal

setSystemLibrarySource

public void setSystemLibrarySource(
IPath source)
Sets the JRE library source zip location.

Parameters:
source - the source to set
Since:
3.4

Eclipse JDT
Release 3.5

Copyright (c) IBM Corp. and others 2000, 2008. All Rights Reserved.

 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire