Class SourceRefElement
java.lang.Object
org.eclipse.core.runtime.PlatformObject
org.aspectj.org.eclipse.jdt.internal.core.JavaElement
org.aspectj.org.eclipse.jdt.internal.core.SourceRefElement
- All Implemented Interfaces:
IJavaElement
,ISourceReference
,org.eclipse.core.runtime.IAdaptable
- Direct Known Subclasses:
Annotation
,ImportContainer
,ImportDeclaration
,LocalVariable
,Member
,PackageDeclaration
,TypeParameter
Abstract class for Java elements which implement ISourceReference.
-
Field Summary
Fields inherited from class org.aspectj.org.eclipse.jdt.internal.core.JavaElement
JEM_ANNOTATION, JEM_CLASSFILE, JEM_COMPILATIONUNIT, JEM_COUNT, JEM_DELIMITER_ESCAPE, JEM_ESCAPE, JEM_FIELD, JEM_IMPORTDECLARATION, JEM_INITIALIZER, JEM_JAVAPROJECT, JEM_LAMBDA_EXPRESSION, JEM_LAMBDA_METHOD, JEM_LOCALVARIABLE, JEM_METHOD, JEM_MODULAR_CLASSFILE, JEM_MODULE, JEM_PACKAGEDECLARATION, JEM_PACKAGEFRAGMENT, JEM_PACKAGEFRAGMENTROOT, JEM_STRING, JEM_TYPE, JEM_TYPE_PARAMETER, NO_ELEMENTS, NO_INFO, NO_STRINGS, parent
Fields inherited from interface org.aspectj.org.eclipse.jdt.core.IJavaElement
ANNOTATION, CLASS_FILE, COMPILATION_UNIT, FIELD, IMPORT_CONTAINER, IMPORT_DECLARATION, INITIALIZER, JAVA_MODEL, JAVA_MODULE, JAVA_PROJECT, LOCAL_VARIABLE, METHOD, PACKAGE_DECLARATION, PACKAGE_FRAGMENT, PACKAGE_FRAGMENT_ROOT, TYPE, TYPE_PARAMETER
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
This element is being closed.void
copy(IJavaElement container, IJavaElement sibling, String rename, boolean force, org.eclipse.core.runtime.IProgressMonitor monitor)
protected Object
Returns a new element info for this element.void
delete(boolean force, org.eclipse.core.runtime.IProgressMonitor monitor)
boolean
Returns true if this handle represents the same Java element as the given handle.findNode(CompilationUnit ast)
Returns theASTNode
that corresponds to thisJavaElement
ornull
if there is no corresponding node.protected void
generateInfos(Object info, HashMap newElements, org.eclipse.core.runtime.IProgressMonitor pm)
Generates the element infos for this element, its ancestors (if they are not opened) and its children (if it is an Openable).getAnnotation(String name)
org.eclipse.core.resources.IResource
Elements within compilation units and class files have no corresponding resource.getHandleFromMemento(String token, MementoTokenizer memento, WorkingCopyOwner workingCopyOwner)
protected void
getHandleMemento(StringBuffer buff)
getHandleUpdatingCountFromMemento(MementoTokenizer memento, WorkingCopyOwner owner)
int
Return the first instance of IOpenable in the hierarchy of this type (going up the hierarchy from this type);org.eclipse.core.runtime.IPath
getPath()
Returns the path to the innermost resource enclosing this element.Returns the source code associated with this element.Returns the source range associated with this element.org.eclipse.core.resources.IResource
Returns the smallest underlying resource that contains this element, ornull
if this element is not contained in a resource.boolean
boolean
Returns whether the structure of this element is known.void
move(IJavaElement container, IJavaElement sibling, String rename, boolean force, org.eclipse.core.runtime.IProgressMonitor monitor)
void
org.eclipse.core.resources.IResource
resource()
protected void
toStringName(StringBuffer buffer)
Debugging purposesMethods inherited from class org.aspectj.org.eclipse.jdt.internal.core.JavaElement
appendEscapedDelimiter, close, escapeMementoName, exists, getAncestor, getAttachedJavadoc, getChildren, getChildrenOfType, getClassFile, getElementInfo, getElementInfo, getElementName, getHandleFromMemento, getHandleIdentifier, getHandleMemento, getHandleMementoDelimiter, getJavadocBaseLocation, getJavaModel, getJavaProject, getLibraryJavadocLocation, getOpenable, getParent, getPrimaryElement, getPrimaryElement, getResource, getSchedulingRule, getSourceElementAt, getSourceMapper, getURLContents, hashCode, isAncestorOf, isReadOnly, newDoesNotExistStatus, newJavaModelException, newNotPresentException, openWhenClosed, readableName, resolved, tabString, toDebugString, toString, toString, toStringAncestors, toStringChildren, toStringInfo, toStringInfo, toStringWithAncestors, toStringWithAncestors, unresolved, validateAndCache
Methods inherited from class org.eclipse.core.runtime.PlatformObject
getAdapter
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
Methods inherited from interface org.aspectj.org.eclipse.jdt.core.IJavaElement
getElementType
Methods inherited from interface org.aspectj.org.eclipse.jdt.core.ISourceReference
exists, getNameRange
-
Field Details
-
occurrenceCount
public int occurrenceCount
-
-
Constructor Details
-
SourceRefElement
-
-
Method Details
-
closing
This element is being closed. Do any necessary cleanup.- Specified by:
closing
in classJavaElement
- Throws:
JavaModelException
-
createElementInfo
Returns a new element info for this element.- Specified by:
createElementInfo
in classJavaElement
-
copy
public void copy(IJavaElement container, IJavaElement sibling, String rename, boolean force, org.eclipse.core.runtime.IProgressMonitor monitor) throws JavaModelException- Throws:
JavaModelException
- See Also:
ISourceManipulation
-
delete
public void delete(boolean force, org.eclipse.core.runtime.IProgressMonitor monitor) throws JavaModelException- Throws:
JavaModelException
- See Also:
ISourceManipulation
-
equals
Description copied from class:JavaElement
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 classJavaElement
- See Also:
Object.equals(java.lang.Object)
-
findNode
Returns theASTNode
that corresponds to thisJavaElement
ornull
if there is no corresponding node.- Overrides:
findNode
in classJavaElement
-
generateInfos
protected void generateInfos(Object info, HashMap newElements, org.eclipse.core.runtime.IProgressMonitor pm) throws JavaModelExceptionDescription copied from class:JavaElement
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.- Specified by:
generateInfos
in classJavaElement
- Throws:
JavaModelException
-
getAnnotation
-
getAnnotations
- Throws:
JavaModelException
-
getCompilationUnit
- Overrides:
getCompilationUnit
in classJavaElement
- See Also:
IMember
-
getCorrespondingResource
Elements within compilation units and class files have no corresponding resource.- Specified by:
getCorrespondingResource
in interfaceIJavaElement
- Returns:
- the corresponding resource, or
null
if none - Throws:
JavaModelException
- if this element does not exist or if an exception occurs while accessing its corresponding resource- See Also:
IJavaElement
-
getHandleFromMemento
public IJavaElement getHandleFromMemento(String token, MementoTokenizer memento, WorkingCopyOwner workingCopyOwner)- Specified by:
getHandleFromMemento
in classJavaElement
-
getHandleMemento
- Overrides:
getHandleMemento
in classJavaElement
-
getHandleUpdatingCountFromMemento
public IJavaElement getHandleUpdatingCountFromMemento(MementoTokenizer memento, WorkingCopyOwner owner) -
getOccurrenceCount
public int getOccurrenceCount() -
getOpenableParent
Return the first instance of IOpenable in the hierarchy of this type (going up the hierarchy from this type);- Overrides:
getOpenableParent
in classJavaElement
-
getPath
public org.eclipse.core.runtime.IPath getPath()Description copied from interface:IJavaElement
Returns the path to the innermost resource enclosing this element. If this element is not included in an external library, the path returned is the full, absolute path to the underlying resource, relative to the workbench. If this element is included in an external library, the path returned is the absolute path to the archive or to the folder in the file system. This is a handle-only method.- Specified by:
getPath
in interfaceIJavaElement
- Returns:
- the path to the innermost resource enclosing this element
-
resource
public org.eclipse.core.resources.IResource resource()- Specified by:
resource
in classJavaElement
-
getSource
Description copied from interface:ISourceReference
Returns the source code associated with this element. This extracts the substring from the source buffer containing this source element. This corresponds to the source range that would be returned bygetSourceRange
.For class files, this returns the source of the entire compilation unit associated with the class file (if there is one).
- Specified by:
getSource
in interfaceISourceReference
- Returns:
- the source code, or
null
if this element has no associated source code - Throws:
JavaModelException
- if an exception occurs while accessing its corresponding resource- See Also:
ISourceReference
-
getSourceRange
Description copied from interface:ISourceReference
Returns the source range associated with this element.For class files, this returns the range of the entire compilation unit associated with the class file (if there is one).
If this element has no associated source code, either
null
is returned, or a source range with a -1 offset and a 0 length.SourceRange.isAvailable(ISourceRange)
can be used to detect that case.- Specified by:
getSourceRange
in interfaceISourceReference
- Returns:
- the source range, or either
null
or [-1, 0] if this element has no associated source code - Throws:
JavaModelException
- if an exception occurs while accessing its corresponding resource- See Also:
ISourceReference
-
getUnderlyingResource
Description copied from interface:IJavaElement
Returns the smallest underlying resource that contains this element, ornull
if this element is not contained in a resource.- Specified by:
getUnderlyingResource
in interfaceIJavaElement
- 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
-
hasChildren
- Overrides:
hasChildren
in classJavaElement
- Throws:
JavaModelException
- See Also:
IParent
-
isStructureKnown
Description copied from interface:IJavaElement
Returns whether the structure of this element is known. For example, for a compilation unit that has syntax errors,false
is returned. If the structure of an element is unknown, navigations will return reasonable defaults. For example,getChildren
for a compilation unit with syntax errors will return a collection of the children that could be parsed.Note: This does not imply anything about consistency with the underlying resource/buffer contents.
- Specified by:
isStructureKnown
in interfaceIJavaElement
- Returns:
true
if the structure of this element is known- Throws:
JavaModelException
- if this element does not exist or if an exception occurs while accessing its corresponding resource- See Also:
IJavaElement
-
move
public void move(IJavaElement container, IJavaElement sibling, String rename, boolean force, org.eclipse.core.runtime.IProgressMonitor monitor) throws JavaModelException- Throws:
JavaModelException
- See Also:
ISourceManipulation
-
rename
public void rename(String newName, boolean force, org.eclipse.core.runtime.IProgressMonitor monitor) throws JavaModelException- Throws:
JavaModelException
- See Also:
ISourceManipulation
-
toStringName
Description copied from class:JavaElement
Debugging purposes- Overrides:
toStringName
in classJavaElement
-