Eclipse Platform
Release 3.0

org.eclipse.debug.core.sourcelookup.containers
Class ArchiveSourceContainer

java.lang.Object
  extended byorg.eclipse.core.runtime.PlatformObject
      extended byorg.eclipse.debug.core.sourcelookup.containers.AbstractSourceContainer
          extended byorg.eclipse.debug.core.sourcelookup.containers.ExternalArchiveSourceContainer
              extended byorg.eclipse.debug.core.sourcelookup.containers.ArchiveSourceContainer
All Implemented Interfaces:
IAdaptable, ISourceContainer

public class ArchiveSourceContainer
extends ExternalArchiveSourceContainer

Archive source container for an archive in the workspace. Returns instances of ZipEntryStorage as source elemetns.

Clients may instantiate this class. This class is not intended to be subclassed.

Since:
3.0

Field Summary
static String TYPE_ID
          Unique identifier for the archive source container type (value org.eclipse.debug.core.containerType.archive).
 
Fields inherited from class org.eclipse.debug.core.sourcelookup.containers.AbstractSourceContainer
EMPTY
 
Constructor Summary
ArchiveSourceContainer(IFile archive, boolean detectRootPath)
          Creates an archive source container on the given file.
 
Method Summary
 boolean equals(Object obj)
           
 IFile getFile()
          Returns the associated file in the workspace.
 String getName()
          The name of this source container that can be used for presentation purposes.
 ISourceContainerType getType()
          Returns this container's type.
 int hashCode()
           
 
Methods inherited from class org.eclipse.debug.core.sourcelookup.containers.ExternalArchiveSourceContainer
dispose, findSourceElements, isDetectRoot
 
Methods inherited from class org.eclipse.debug.core.sourcelookup.containers.AbstractSourceContainer
abort, getDirector, getSourceContainers, getSourceContainerType, init, isComposite, isFindDuplicates
 
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
 

Field Detail

TYPE_ID

public static final String TYPE_ID
Unique identifier for the archive source container type (value org.eclipse.debug.core.containerType.archive).

Constructor Detail

ArchiveSourceContainer

public ArchiveSourceContainer(IFile archive,
                              boolean detectRootPath)
Creates an archive source container on the given file.

Parameters:
archive - archive in the workspace
detectRootPath - whether a root path should be detected. When true, searching is performed relative to a root path within the archive based on fully qualified file names. The root path is automatically determined when the first successful search is performed. For example, when searching for a file named a/b/c.d, and an entry in the archive named r/a/b/c.d exists, the root path is set to r. From that point on, searching is performed relative to r. When false, searching is performed by matching file names as suffixes to the entries in the archive.
Method Detail

getName

public String getName()
Description copied from interface: ISourceContainer
The name of this source container that can be used for presentation purposes. For example, the name of a project.

Specified by:
getName in interface ISourceContainer
Overrides:
getName in class ExternalArchiveSourceContainer

getFile

public IFile getFile()
Returns the associated file in the workspace.

Returns:
associated file in the workspace

getType

public ISourceContainerType getType()
Description copied from interface: ISourceContainer
Returns this container's type.

Specified by:
getType in interface ISourceContainer
Overrides:
getType in class ExternalArchiveSourceContainer

equals

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

hashCode

public int hashCode()
Overrides:
hashCode in class ExternalArchiveSourceContainer

Eclipse Platform
Release 3.0

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.