Eclipse JDT
2.1

org.eclipse.jdt.launching.sourcelookup
Class ArchiveSourceLocation

java.lang.Object
  |
  +--org.eclipse.core.runtime.PlatformObject
        |
        +--org.eclipse.jdt.launching.sourcelookup.ArchiveSourceLocation
All Implemented Interfaces:
IAdaptable, IJavaSourceLocation

public class ArchiveSourceLocation
extends PlatformObject
implements IJavaSourceLocation

Locates source elements in an archive (zip) in the local file system. Returns instances of ZipEntryStorage.

This class may be instantiated; it is not intended to be subclassed.

Since:
2.0
See Also:
IJavaSourceLocation

Constructor Summary
ArchiveSourceLocation()
          Constructs a new empty source location to be initialized with a memento.
ArchiveSourceLocation(String archiveName, String sourceRoot)
          Constructs a new source location that will retrieve source elements from the zip file with the given name.
 
Method Summary
static void closeArchives()
          Closes all zip files that have been opened, and removes them from the zip file cache.
 boolean equals(Object object)
           
 Object findSourceElement(String name)
          Returns an object representing the source code for a type with the specified name, or null if none could be found.
protected  ZipFile getArchive()
          Returns the archive associated with this source location.
 String getMemento()
          Returns a memento for this source location from which this source location can be reconstructed.
 String getName()
          Returns the name of the archive associated with this source location
 IPath getRootPath()
          Returns the location of the root source folder within the archive, or null if the root source folder is the root of the arhcive
 int hashCode()
           
 void initializeFrom(String memento)
          Initializes this source location from the given memento.
 
Methods inherited from class org.eclipse.core.runtime.PlatformObject
getAdapter
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Constructor Detail

ArchiveSourceLocation

public ArchiveSourceLocation()
Constructs a new empty source location to be initialized with a memento.

ArchiveSourceLocation

public ArchiveSourceLocation(String archiveName,
                             String sourceRoot)
Constructs a new source location that will retrieve source elements from the zip file with the given name.
Parameters:
archive - zip file
sourceRoot - a path to the root source folder in the specified archive, or null if the root source folder is the root of the archive
Method Detail

closeArchives

public static void closeArchives()
Closes all zip files that have been opened, and removes them from the zip file cache. This method is only to be called by the launching plug-in.

findSourceElement

public Object findSourceElement(String name)
                         throws CoreException
Description copied from interface: IJavaSourceLocation
Returns an object representing the source code for a type with the specified name, or null if none could be found. The name is a fully qualified type name, and may contain the '$' character when referring to inner types. For example, java.lang.String. The source element returned is implementation specific - for example, a resource, a local file, a zip file entry, etc.
Specified by:
findSourceElement in interface IJavaSourceLocation
See Also:
IJavaSourceLocation.findSourceElement(String)

getArchive

protected ZipFile getArchive()
                      throws IOException
Returns the archive associated with this source location.
Returns:
zip file

getRootPath

public IPath getRootPath()
Returns the location of the root source folder within the archive, or null if the root source folder is the root of the arhcive
Returns:
the location of the root source folder within the archive, or null if the root source folder is the root of the arhcive

getName

public String getName()
Returns the name of the archive associated with this source location
Returns:
the name of the archive associated with this source location

equals

public boolean equals(Object object)
Overrides:
equals in class Object
See Also:
Object.equals(java.lang.Object)

hashCode

public int hashCode()
Overrides:
hashCode in class Object
See Also:
Object.hashCode()

getMemento

public String getMemento()
                  throws CoreException
Description copied from interface: IJavaSourceLocation
Returns a memento for this source location from which this source location can be reconstructed.
Specified by:
getMemento in interface IJavaSourceLocation
See Also:
IJavaSourceLocation.getMemento()

initializeFrom

public void initializeFrom(String memento)
                    throws CoreException
Description copied from interface: IJavaSourceLocation
Initializes this source location from the given memento.
Specified by:
initializeFrom in interface IJavaSourceLocation
See Also:
IJavaSourceLocation.initializeFrom(String)

Eclipse JDT
2.1

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