|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.core.runtime.PlatformObject
org.eclipse.debug.core.sourcelookup.containers.AbstractSourceContainer
org.eclipse.debug.core.sourcelookup.containers.ArchiveSourceContainer
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.
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 | |
---|---|
void |
dispose()
Disposes this source container. |
boolean |
equals(Object obj)
|
Object[] |
findSourceElements(String name)
Returns a collection of source elements in this container corresponding to the given name. |
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()
|
void |
init(ISourceLookupDirector director)
Notifiation this source container has been added to the given source lookup director. |
boolean |
isDetectRoot()
Returns whether root paths are automatically detected in this archive source container. |
Methods inherited from class org.eclipse.debug.core.sourcelookup.containers.AbstractSourceContainer |
---|
abort, getDirector, getSourceContainers, getSourceContainerType, 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 |
public static final String TYPE_ID
org.eclipse.debug.core.containerType.archive
).
Constructor Detail |
public ArchiveSourceContainer(IFile archive, boolean detectRootPath)
archive
- archive in the workspacedetectRootPath
- 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 |
public String getName()
ISourceContainer
public IFile getFile()
public ISourceContainerType getType()
ISourceContainer
public boolean equals(Object obj)
public int hashCode()
public Object[] findSourceElements(String name) throws CoreException
ISourceContainer
isFindDuplicates()
.
When false
the returned collection should contain at most one
source element. If this is a composite container, the containers contained
by this container are also searched.
The format of the given name is implementation specific but generally conforms to the format of a file name. If a source container does not recognize the name format provided, an empty collection should be returned. A source container may or may not require names to be fully qualified (i.e. be qualified with directory names).
name
- the name of the source element to search for
CoreException
- if an exception occurrs while searching for source elementspublic void init(ISourceLookupDirector director)
ISourceContainer
init
in interface ISourceContainer
init
in class AbstractSourceContainer
public void dispose()
ISourceContainer
dispose
in interface ISourceContainer
dispose
in class AbstractSourceContainer
public boolean isDetectRoot()
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.