Class ArchiveSourceContainer
java.lang.Object
org.eclipse.core.runtime.PlatformObject
org.eclipse.debug.core.sourcelookup.containers.AbstractSourceContainer
org.eclipse.debug.core.sourcelookup.containers.ArchiveSourceContainer
- All Implemented Interfaces:
IAdaptable,ISourceContainer
Archive source container for an archive in the workspace. Returns instances
of
ZipEntryStorage as source elements.
Clients may instantiate this class.
- Since:
- 3.0
- Restriction:
- This class is not intended to be subclassed by clients.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringUnique identifier for the archive source container type (valueorg.eclipse.debug.core.containerType.archive).Fields inherited from class org.eclipse.debug.core.sourcelookup.containers.AbstractSourceContainer
EMPTY -
Constructor Summary
ConstructorsConstructorDescriptionArchiveSourceContainer(IFile archive, boolean detectRootPath) Creates an archive source container on the given file. -
Method Summary
Modifier and TypeMethodDescriptionvoiddispose()Disposes this source container.booleanObject[]findSourceElements(String name) Returns a collection of source elements in this container corresponding to the given name.getFile()Returns the associated file in the workspace.getName()The name of this source container that can be used for presentation purposes.getType()Returns this container's type.inthashCode()voidinit(ISourceLookupDirector director) Notification this source container has been added to the given source lookup director.booleanReturns 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, warnMethods inherited from class org.eclipse.core.runtime.PlatformObject
getAdapterMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
-
Field Details
-
TYPE_ID
Unique identifier for the archive source container type (valueorg.eclipse.debug.core.containerType.archive).
-
-
Constructor Details
-
ArchiveSourceContainer
Creates an archive source container on the given file.- Parameters:
archive- archive in the workspacedetectRootPath- whether a root path should be detected. Whentrue, 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 nameda/b/c.d, and an entry in the archive namedr/a/b/c.dexists, the root path is set tor. From that point on, searching is performed relative tor. Whenfalse, searching is performed by matching file names as suffixes to the entries in the archive.
-
-
Method Details
-
getName
Description copied from interface:ISourceContainerThe name of this source container that can be used for presentation purposes. For example, the name of a project.- Returns:
- the name of this source container
-
getFile
Returns the associated file in the workspace.- Returns:
- associated file in the workspace
-
getType
Description copied from interface:ISourceContainerReturns this container's type.- Returns:
- this container's type
-
equals
-
hashCode
public int hashCode() -
findSourceElements
Description copied from interface:ISourceContainerReturns a collection of source elements in this container corresponding to the given name. Returns an empty collection if no source elements are found. This source container's source lookup director specifies if duplicate source elements should be searched for, viaisFindDuplicates(). Whenfalsethe 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).
- Parameters:
name- the name of the source element to search for- Returns:
- a collection of source elements corresponding to the given name
- Throws:
CoreException- if an exception occurs while searching for source elements
-
init
Description copied from interface:ISourceContainerNotification this source container has been added to the given source lookup director.- Specified by:
initin interfaceISourceContainer- Overrides:
initin classAbstractSourceContainer- Parameters:
director- the director this container has been added to
-
dispose
public void dispose()Description copied from interface:ISourceContainerDisposes this source container. This method is called when the source director associated with this source container is disposed.- Specified by:
disposein interfaceISourceContainer- Overrides:
disposein classAbstractSourceContainer
-
isDetectRoot
public boolean isDetectRoot()Returns whether root paths are automatically detected in this archive source container.- Returns:
- whether root paths are automatically detected in this archive source container
- Since:
- 3.0.1.1
-