Class JavaElement

java.lang.Object
org.eclipse.core.runtime.PlatformObject
org.aspectj.org.eclipse.jdt.internal.core.JavaElement
All Implemented Interfaces:
IJavaElement, org.eclipse.core.runtime.IAdaptable
Direct Known Subclasses:
Openable, SourceRefElement
public abstract class JavaElement extends org.eclipse.core.runtime.PlatformObject implements IJavaElement
Root of Java element handle hierarchy.
See Also:

  • Field Details

    • JEM_ESCAPE

      public static final char JEM_ESCAPE
      See Also:

    • JEM_JAVAPROJECT

      public static final char JEM_JAVAPROJECT
      See Also:

    • JEM_PACKAGEFRAGMENTROOT

      public static final char JEM_PACKAGEFRAGMENTROOT
      See Also:

    • JEM_PACKAGEFRAGMENT

      public static final char JEM_PACKAGEFRAGMENT
      See Also:

    • JEM_FIELD

      public static final char JEM_FIELD
      See Also:

    • JEM_METHOD

      public static final char JEM_METHOD
      See Also:

    • JEM_INITIALIZER

      public static final char JEM_INITIALIZER
      See Also:

    • JEM_COMPILATIONUNIT

      public static final char JEM_COMPILATIONUNIT
      See Also:

    • JEM_CLASSFILE

      public static final char JEM_CLASSFILE
      See Also:

    • JEM_MODULAR_CLASSFILE

      public static final char JEM_MODULAR_CLASSFILE
      See Also:

    • JEM_TYPE

      public static final char JEM_TYPE
      See Also:

    • JEM_PACKAGEDECLARATION

      public static final char JEM_PACKAGEDECLARATION
      See Also:

    • JEM_IMPORTDECLARATION

      public static final char JEM_IMPORTDECLARATION
      See Also:

    • JEM_COUNT

      public static final char JEM_COUNT
      See Also:

    • JEM_LOCALVARIABLE

      public static final char JEM_LOCALVARIABLE
      See Also:

    • JEM_TYPE_PARAMETER

      public static final char JEM_TYPE_PARAMETER
      See Also:

    • JEM_ANNOTATION

      public static final char JEM_ANNOTATION
      See Also:

    • JEM_LAMBDA_EXPRESSION

      public static final char JEM_LAMBDA_EXPRESSION
      See Also:

    • JEM_LAMBDA_METHOD

      public static final char JEM_LAMBDA_METHOD
      See Also:

    • JEM_STRING

      public static final char JEM_STRING
      See Also:

    • JEM_MODULE

      public static final char JEM_MODULE
      See Also:

    • JEM_DELIMITER_ESCAPE

      public static final char JEM_DELIMITER_ESCAPE
      Before ')', '&' and '"' became the newest additions as delimiters, the former two were allowed as part of element attributes and possibly stored. Trying to recreate elements from such memento would cause undesirable results. Consider the following valid project name: (abc) If we were to use ')' alone as the delimiter and decode the above name, the memento would be wrongly identified to contain a lambda expression. In order to differentiate delimiters from characters that are part of element attributes, the following escape character is being introduced and all the new delimiters must be escaped with this. So, a lambda expression would be written as: "=)..."
      See Also:

    • NO_STRINGS

      public static final String[] NO_STRINGS

    • NO_ELEMENTS

      protected static final JavaElement[] NO_ELEMENTS

    • NO_INFO

      protected static final Object NO_INFO

  • Constructor Details

    • JavaElement

      protected JavaElement(JavaElement parent) throws IllegalArgumentException
      Constructs a handle for a java element with the given parent element.
      Parameters:
      parent - The parent of java element
      Throws:
      IllegalArgumentException - if the type is not one of the valid Java element type constants

  • Method Details

    • close

      public void close() throws JavaModelException
      Throws:
      JavaModelException
      See Also:

    • closing

      protected abstract void closing(Object info) throws JavaModelException
      This element is being closed. Do any necessary cleanup.
      Throws:
      JavaModelException

    • createElementInfo

      protected abstract JavaElementInfo createElementInfo()

    • equals

      public boolean equals(Object o)
      Returns true if this handle represents the same Java element as the given handle. By default, two handles represent the same element if they are identical or if they represent the same type of element, have equal names, parents, and occurrence counts.

      If a subclass has other requirements for equality, this method must be overridden.

      Overrides:
      equals in class Object
      See Also:

    • appendEscapedDelimiter

      protected void appendEscapedDelimiter(StringBuilder buffer, char delimiter)
      See Also:

    • escapeMementoName

      protected void escapeMementoName(StringBuilder buffer, String mementoName)

    • exists

      public boolean exists()
      Description copied from interface: IJavaElement
      Returns whether this Java element exists in the model.

      Java elements are handle objects that may or may not be backed by an actual element. Java elements that are backed by an actual element are said to "exist", and this method returns true. For Java elements that are not working copies, it is always the case that if the element exists, then its parent also exists (provided it has one) and includes the element as one of its children. It is therefore possible to navigated to any existing Java element from the root of the Java model along a chain of existing Java elements. On the other hand, working copies are said to exist until they are destroyed (with IWorkingCopy.destroy). Unlike regular Java elements, a working copy never shows up among the children of its parent element (which may or may not exist).

      Specified by:
      exists in interface IJavaElement
      Returns:
      true if this element exists in the Java model, and false if this element does not exist
      See Also:

    • findNode

      public ASTNode findNode(CompilationUnit ast)
      Returns the ASTNode that corresponds to this JavaElement or null if there is no corresponding node.

    • generateInfos

      protected abstract void generateInfos(IElementInfo info, Map<IJavaElement,IElementInfo> newElements, org.eclipse.core.runtime.IProgressMonitor pm) throws JavaModelException
      Generates the element infos for this element, its ancestors (if they are not opened) and its children (if it is an Openable). Puts the newly created element info in the given map.
      Throws:
      JavaModelException

    • getAncestor

      public IJavaElement getAncestor(int ancestorType)
      Description copied from interface: IJavaElement
      Returns this Java element or the first ancestor of this element that has the given type. Returns null if no such element can be found. This is a handle-only method.
      Specified by:
      getAncestor in interface IJavaElement
      Parameters:
      ancestorType - the given type
      Returns:
      this Java element or the first ancestor of this element that has the given type, or null if no such element can be found
      See Also:

    • getChildren

      public IJavaElement[] getChildren() throws JavaModelException
      Throws:
      JavaModelException
      See Also:

    • getChildrenOfType

      public ArrayList getChildrenOfType(int type) throws JavaModelException
      Returns a collection of (immediate) children of this node of the specified type.
      Parameters:
      type - - one of the JEM_* constants defined by JavaElement
      Throws:
      JavaModelException

    • getClassFile

      public IClassFile getClassFile()
      See Also:

    • getCompilationUnit

      public ICompilationUnit getCompilationUnit()
      See Also:

    • getElementInfo

      public IElementInfo getElementInfo() throws JavaModelException
      Returns the info for this handle. If this element is not already open, it and all of its parents are opened. Does not return null. NOTE: BinaryType infos are NOT rooted under JavaElementInfo.
      Throws:
      JavaModelException - if the element is not present or not accessible

    • getElementInfo

      public IElementInfo getElementInfo(org.eclipse.core.runtime.IProgressMonitor monitor) throws JavaModelException
      Returns the info for this handle. If this element is not already open, it and all of its parents are opened. Does not return null. NOTE: BinaryType infos are NOT rooted under JavaElementInfo.
      Throws:
      JavaModelException - if the element is not present or not accessible

    • getElementName

      public 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
      Returns:
      the element name
      See Also:
      • IAdaptable

    • getHandleFromMemento

      public abstract IJavaElement getHandleFromMemento(String token, MementoTokenizer memento, WorkingCopyOwner owner)

    • getHandleFromMemento

      public IJavaElement getHandleFromMemento(MementoTokenizer memento, WorkingCopyOwner owner)

    • getHandleIdentifier

      public String getHandleIdentifier()
      Description copied from interface: IJavaElement
      Returns a string representation of this element handle. The format of the string is not specified; however, the identifier is stable across workspace sessions, and can be used to recreate this handle via the JavaCore.create(String) method.
      Specified by:
      getHandleIdentifier in interface IJavaElement
      Returns:
      the string handle identifier
      See Also:

    • getHandleMemento

      public String getHandleMemento()
      See Also:

    • getHandleMemento

      protected void getHandleMemento(StringBuilder buff)

    • getHandleMementoDelimiter

      protected abstract char getHandleMementoDelimiter()
      Returns the char that marks the start of this handles contribution to a memento.

    • getJavaModel

      public JavaModel getJavaModel()
      Description copied from interface: IJavaElement
      Returns the Java model. This is a handle-only method.
      Specified by:
      getJavaModel in interface IJavaElement
      Returns:
      the Java model
      See Also:

    • getJavaProject

      public JavaProject getJavaProject()
      Description copied from interface: IJavaElement
      Returns the Java project this element is contained in, or null if this element is not contained in any Java project (for instance, the IJavaModel is not contained in any Java project). This is a handle-only method.
      Specified by:
      getJavaProject in interface IJavaElement
      Returns:
      the containing Java project, or null if this element is not contained in a Java project
      See Also:

    • getOpenable

      public IOpenable getOpenable()
      Description copied from interface: IJavaElement
      Returns the first openable parent. If this element is openable, the element itself is returned. Returns null if this element doesn't have an openable parent. This is a handle-only method.
      Specified by:
      getOpenable in interface IJavaElement
      Returns:
      the first openable parent or null if this element doesn't have an openable parent.

    • getOpenableParent

      public IOpenable getOpenableParent()
      Return the first instance of IOpenable in the parent hierarchy of this element.

      Subclasses that are not IOpenable's must override this method.

    • getParent

      public JavaElement getParent()
      Description copied from interface: IJavaElement
      Returns the element directly containing this element, or null if this element has no parent. This is a handle-only method.
      Specified by:
      getParent in interface IJavaElement
      Returns:
      the parent element, or null if this element has no parent
      See Also:

    • getPrimaryElement

      public JavaElement getPrimaryElement()
      Description copied from interface: IJavaElement
      Returns the primary element (whose compilation unit is the primary compilation unit) this working copy element was created from, or this element if it is a descendant of a primary compilation unit or if it is not a descendant of a working copy (e.g. it is a binary member). The returned element may or may not exist.
      Specified by:
      getPrimaryElement in interface IJavaElement
      Returns:
      the primary element this working copy element was created from, or this element.

    • getPrimaryElement

      public JavaElement getPrimaryElement(boolean checkOwner)

    • getResource

      public org.eclipse.core.resources.IResource getResource()
      Description copied from interface: IJavaElement
      Returns the innermost resource enclosing this element. If this element is included in an archive and this archive is not external, this is the underlying resource corresponding to the archive. If this element is included in an external library, null is returned. This is a handle-only method.
      Specified by:
      getResource in interface IJavaElement
      Returns:
      the innermost resource enclosing this element, null if this element is included in an external archive

    • resource

      public abstract org.eclipse.core.resources.IResource resource()

    • getSourceElementAt

      protected IJavaElement getSourceElementAt(int position) throws JavaModelException
      Returns the element that is located at the given source position in this element. This is a helper method for ICompilationUnit#getElementAt, and only works on compilation units and types. The position given is known to be within this element's source range already, and if no finer grained element is found at the position, this element is returned.
      Throws:
      JavaModelException

    • getSourceMapper

      public SourceMapper getSourceMapper()
      Returns the SourceMapper facility for this element, or null if this element does not have a SourceMapper.

    • getSchedulingRule

      public org.eclipse.core.runtime.jobs.ISchedulingRule getSchedulingRule()
      Description copied from interface: IJavaElement
      Returns the scheduling rule associated with this Java element. This is a handle-only method.
      Specified by:
      getSchedulingRule in interface IJavaElement
      Returns:
      the scheduling rule associated with this Java element

    • hasChildren

      public boolean hasChildren() throws JavaModelException
      Throws:
      JavaModelException
      See Also:

    • hashCode

      public final int hashCode()
      Returns the hash code for this Java element. By default, the hash code for an element is a combination of its thisgetElementName() and parent's hash code. Elements with other requirements must override thiscalculateHashCode().
      Overrides:
      hashCode in class Object

    • resetHashCode

      protected void resetHashCode()
      should not be needed but some implementations do have mutable member "occurrenceCount"

    • calculateHashCode

      protected int calculateHashCode()

    • isAncestorOf

      public boolean isAncestorOf(IJavaElement e)
      Returns true if this element is an ancestor of the given element, otherwise false.

    • isReadOnly

      public boolean isReadOnly()
      Description copied from interface: IJavaElement
      Returns whether this Java element is read-only. An element is read-only if its structure cannot be modified by the java model.

      Note this is different from IResource.isReadOnly(). For example, .jar files are read-only as the java model doesn't know how to add/remove elements in this file, but the underlying IFile can be writable.

      This is a handle-only method.

      Specified by:
      isReadOnly in interface IJavaElement
      Returns:
      true if this element is read-only
      See Also:

    • newNotPresentException

      public JavaModelException newNotPresentException()
      Creates and returns a new not present exception for this element.

    • newDoesNotExistStatus

      protected JavaModelStatus newDoesNotExistStatus()

    • newJavaModelException

      public JavaModelException newJavaModelException(org.eclipse.core.runtime.IStatus status)
      Creates and returns a new Java model exception for this element with the given status.

    • openWhenClosed

      protected IElementInfo openWhenClosed(IElementInfo info, boolean forceAdd, org.eclipse.core.runtime.IProgressMonitor monitor) throws JavaModelException
      Throws:
      JavaModelException

    • readableName

      public String readableName()

    • resolved

      public JavaElement resolved(Binding binding)

    • unresolved

      public JavaElement unresolved()

    • tabString

      protected String tabString(int tab)

    • toDebugString

      public String toDebugString()
      Debugging purposes

    • toString

      public String toString()
      Debugging purposes
      Overrides:
      toString in class Object

    • toString

      protected void toString(int tab, StringBuilder buffer)
      Debugging purposes

    • toStringWithAncestors

      public String toStringWithAncestors()
      Debugging purposes

    • toStringWithAncestors

      public String toStringWithAncestors(boolean showResolvedInfo)
      Debugging purposes

    • toStringAncestors

      protected void toStringAncestors(StringBuilder buffer)
      Debugging purposes

    • toStringChildren

      protected void toStringChildren(int tab, StringBuilder buffer, Object info)
      Debugging purposes

    • toStringInfo

      public Object toStringInfo(int tab, StringBuilder buffer)
      Debugging purposes

    • toStringInfo

      protected void toStringInfo(int tab, StringBuilder buffer, Object info, boolean showResolvedInfo)
      Debugging purposes
      Parameters:
      showResolvedInfo - TODO

    • toStringName

      protected void toStringName(StringBuilder buffer)
      Debugging purposes

    • getJavadocBaseLocation

      protected URL getJavadocBaseLocation() throws JavaModelException
      Throws:
      JavaModelException

    • getLibraryJavadocLocation

      protected static URL getLibraryJavadocLocation(IClasspathEntry entry) throws JavaModelException
      Throws:
      JavaModelException

    • getAttachedJavadoc

      public String getAttachedJavadoc(org.eclipse.core.runtime.IProgressMonitor monitor) throws JavaModelException
      Description copied from interface: IJavaElement

      Returns the Javadoc as HTML source if this element has attached Javadoc, null otherwise.

      This should be used only for binary elements. Source elements will always return null.

      The encoding used to read the Javadoc is the one defined by the content type of the file. If none is defined, then the project's encoding of this Java element is used. If the project's encoding cannot be retrieved, then the platform encoding is used.

      In case the Javadoc doesn't exist for this element, null is returned.

      The HTML is extracted from the attached Javadoc and provided as is. No transformation or validation is done.

      Specified by:
      getAttachedJavadoc in interface IJavaElement
      Parameters:
      monitor - the given progress monitor, can be null
      Returns:
      the extracted javadoc from the attached javadoc, null if none
      Throws:
      JavaModelException - if:
      • this element does not exist
      • retrieving the attached javadoc fails (timed-out, invalid URL, ...)
      • the format of the javadoc doesn't match expected standards (different anchors,...)
      See Also:

    • validateAndCache

      protected void validateAndCache(URL baseLoc, FileNotFoundException e) throws JavaModelException
      Throws:
      JavaModelException

    • getURLContents

      protected String getURLContents(URL baseLoc, String docUrlValue) throws JavaModelException
      Throws:
      JavaModelException