org.eclipse.jdt.internal.core
Class JarPackageFragmentRoot

java.lang.Object
  org.eclipse.core.runtime.PlatformObject
      org.eclipse.jdt.internal.core.JavaElement
          org.eclipse.jdt.internal.core.Openable
              org.eclipse.jdt.internal.core.PackageFragmentRoot
                  org.eclipse.jdt.internal.core.JarPackageFragmentRoot

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable, IBufferChangedListener, IJavaElement, IOpenable, IPackageFragmentRoot, IParent

public class JarPackageFragmentRoot
extends PackageFragmentRoot

A package fragment root that corresponds to a .jar or .zip.

NOTE: The only visible entries from a .jar or .zip package fragment root are .class files.

NOTE: A jar package fragment root may or may not have an associated resource.

See Also:

IPackageFragmentRoot, JarPackageFragmentRootInfo

Field Summary

Fields inherited from class org.eclipse.jdt.internal.core.PackageFragmentRoot

NO_SOURCE_ATTACHMENT

Fields inherited from class org.eclipse.jdt.internal.core.JavaElement

JEM_ANNOTATION, JEM_CLASSFILE, JEM_COMPILATIONUNIT, JEM_COUNT, JEM_ESCAPE, JEM_FIELD, JEM_IMPORTDECLARATION, JEM_INITIALIZER, JEM_JAVAPROJECT, JEM_LOCALVARIABLE, JEM_METHOD, JEM_PACKAGEDECLARATION, JEM_PACKAGEFRAGMENT, JEM_PACKAGEFRAGMENTROOT, JEM_TYPE, JEM_TYPE_PARAMETER

Fields inherited from interface org.eclipse.jdt.core.IPackageFragmentRoot

DEFAULT_PACKAGEROOT_PATH, DESTINATION_PROJECT_CLASSPATH, K_BINARY, K_SOURCE, NO_RESOURCE_MODIFICATION, ORIGINATING_PROJECT_CLASSPATH, OTHER_REFERRING_PROJECTS_CLASSPATH, REPLACE

Fields inherited from interface org.eclipse.jdt.core.IJavaElement

ANNOTATION, CLASS_FILE, COMPILATION_UNIT, FIELD, IMPORT_CONTAINER, IMPORT_DECLARATION, INITIALIZER, JAVA_MODEL, JAVA_PROJECT, LOCAL_VARIABLE, METHOD, PACKAGE_DECLARATION, PACKAGE_FRAGMENT, PACKAGE_FRAGMENT_ROOT, TYPE, TYPE_PARAMETER

Method Summary

boolean	equals(java.lang.Object o) Returns true if this handle represents the same jar as the given handle.
java.lang.String	getElementName() Returns the name of this element.
java.util.zip.ZipFile	getJar() Returns the underlying ZipFile for this Jar package fragment root.
int	getKind() Returns this package fragment root's kind encoded as an integer.
java.lang.Object[]	getNonJavaResources() Returns an array of non-java resources contained in the receiver.
PackageFragment	getPackageFragment(java.lang.String[] pkgName)
IResource	getUnderlyingResource() Returns the smallest underlying resource that contains this element, or null if this element is not contained in a resource.
int	hashCode() Returns the hash code for this Java element.
org.eclipse.core.runtime.IPath	internalPath()
boolean	isArchive() Returns whether this package fragment root's underlying resource is a binary archive (a JAR or zip file).
boolean	isExternal() Returns whether this package fragment root is external to the workbench (that is, a local file), and has no underlying resource.
boolean	isReadOnly() Jars and jar entries are all read only
IResource	resource(PackageFragmentRoot root)

Methods inherited from class org.eclipse.jdt.internal.core.PackageFragmentRoot

attachSource, copy, createPackageFragment, delete, fullExclusionPatternChars, fullInclusionPatternChars, getElementType, getHandleFromMemento, getPackageFragment, getPath, getRawClasspathEntry, getSourceAttachmentPath, getSourceAttachmentRootPath, getSourceMapper, hasChildren, move, resource, setSourceMapper

Methods inherited from class org.eclipse.jdt.internal.core.Openable

bufferChanged, canBeRemovedFromCache, canBufferBeRemovedFromCache, exists, findRecommendedLineSeparator, getBuffer, getBufferFactory, getCorrespondingResource, getOpenable, getPackageFragmentRoot, getResource, hasUnsavedChanges, isConsistent, isOpen, isStructureKnown, makeConsistent, open, save

Methods inherited from class org.eclipse.jdt.internal.core.JavaElement

close, findNode, getAncestor, getAttachedJavadoc, getChildren, getChildrenOfType, getClassFile, getCompilationUnit, getElementInfo, getElementInfo, getHandleFromMemento, getHandleIdentifier, getHandleMemento, getJavaModel, getJavaProject, getOpenableParent, getParent, getPrimaryElement, getPrimaryElement, getSchedulingRule, isAncestorOf, newJavaModelException, newNotPresentException, readableName, resolved, toDebugString, toString, toStringInfo, toStringWithAncestors, toStringWithAncestors, unresolved

Methods inherited from class org.eclipse.core.runtime.PlatformObject

getAdapter

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jdt.core.IParent

getChildren

Methods inherited from interface org.eclipse.jdt.core.IJavaElement

exists, getAncestor, getAttachedJavadoc, getCorrespondingResource, getHandleIdentifier, getJavaModel, getJavaProject, getOpenable, getParent, getPrimaryElement, getResource, getSchedulingRule, isStructureKnown

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Methods inherited from interface org.eclipse.jdt.core.IOpenable

close, findRecommendedLineSeparator, getBuffer, hasUnsavedChanges, isConsistent, isOpen, makeConsistent, open, save

Method Detail

equals

public boolean equals(java.lang.Object o)

Returns true if this handle represents the same jar as the given handle. Two jars are equal if they share the same zip file.

Overrides:

equals in class PackageFragmentRoot

See Also:

Object.equals(java.lang.Object)

getElementName

public java.lang.String getElementName()

Description copied from interface: IJavaElement

Returns the name of this element. This is a handle-only method.

Specified by:

getElementName in interface IJavaElement

Overrides:

getElementName in class PackageFragmentRoot

Returns:

the element name

See Also:

IAdaptable

getJar

public java.util.zip.ZipFile getJar()
                             throws org.eclipse.core.runtime.CoreException

Returns the underlying ZipFile for this Jar package fragment root.

Throws:

org.eclipse.core.runtime.CoreException - if an error occurs accessing the jar

getKind

public int getKind()

Description copied from interface: IPackageFragmentRoot

Returns this package fragment root's kind encoded as an integer. A package fragment root can contain source files (i.e. files with one of the Java-like extensions, or .class files, but not both. If the underlying folder or archive contains other kinds of files, they are ignored. In particular, .class files are ignored under a source package fragment root, and source files are ignored under a binary package fragment root.

Specified by:

getKind in interface IPackageFragmentRoot

Overrides:

getKind in class PackageFragmentRoot

Returns:

this package fragment root's kind encoded as an integer

See Also:

IPackageFragmentRoot

getNonJavaResources

public java.lang.Object[] getNonJavaResources()
                                       throws JavaModelException

Returns an array of non-java resources contained in the receiver.

Specified by:

getNonJavaResources in interface IPackageFragmentRoot

Overrides:

getNonJavaResources in class PackageFragmentRoot

Returns:

an array of non-Java resources (IFiles, IFolders, or IStorages if the package fragment root is in archive) contained in this package fragment root

Throws:

JavaModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource.

See Also:

IClasspathEntry.getInclusionPatterns(), IClasspathEntry.getExclusionPatterns()

getPackageFragment

public PackageFragment getPackageFragment(java.lang.String[] pkgName)

Overrides:

getPackageFragment in class PackageFragmentRoot

internalPath

public org.eclipse.core.runtime.IPath internalPath()

Overrides:

internalPath in class PackageFragmentRoot

resource

public IResource resource(PackageFragmentRoot root)

Overrides:

resource in class PackageFragmentRoot

getUnderlyingResource

public IResource getUnderlyingResource()
                                throws JavaModelException

Description copied from interface: IJavaElement

Returns the smallest underlying resource that contains this element, or null if this element is not contained in a resource.

Specified by:

getUnderlyingResource in interface IJavaElement

Overrides:

getUnderlyingResource in class PackageFragmentRoot

Returns:

the underlying resource, or null if none

Throws:

JavaModelException - if this element does not exist or if an exception occurs while accessing its underlying resource

See Also:

IJavaElement

hashCode

public int hashCode()

Description copied from class: JavaElement

Returns the hash code for this Java element. By default, the hash code for an element is a combination of its name and parent's hash code. Elements with other requirements must override this method.

Overrides:

hashCode in class PackageFragmentRoot

isArchive

public boolean isArchive()

Description copied from interface: IPackageFragmentRoot

Returns whether this package fragment root's underlying resource is a binary archive (a JAR or zip file).

This is a handle-only method.

Specified by:

isArchive in interface IPackageFragmentRoot

Overrides:

isArchive in class PackageFragmentRoot

Returns:

true if this package fragment root's underlying resource is a binary archive, false otherwise

See Also:

IPackageFragmentRoot

isExternal

public boolean isExternal()

Description copied from interface: IPackageFragmentRoot

Returns whether this package fragment root is external to the workbench (that is, a local file), and has no underlying resource.

This is a handle-only method.

Specified by:

isExternal in interface IPackageFragmentRoot

Overrides:

isExternal in class PackageFragmentRoot

Returns:

true if this package fragment root is external to the workbench (that is, a local file), and has no underlying resource, false otherwise

See Also:

IPackageFragmentRoot

isReadOnly

public boolean isReadOnly()

Jars and jar entries are all read only

Specified by:

isReadOnly in interface IJavaElement

Overrides:

isReadOnly in class JavaElement

Returns:

true if this element is read-only

See Also:

IJavaElement