Class Member
- All Implemented Interfaces:
IJavaElement
,IMember
,IParent
,ISourceManipulation
,ISourceReference
,org.eclipse.core.runtime.IAdaptable
- Direct Known Subclasses:
Initializer
,NamedMember
- See Also:
IMember
-
Field Summary
Fields inherited from class org.aspectj.org.eclipse.jdt.internal.core.SourceRefElement
occurrenceCount
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 static boolean
areSimilarMethods(String name1, String[] params1, String name2, String[] params2, String[] simpleNames1)
protected static Object
convertConstant(Constant constant)
Converts a field constant from the compiler's representation to the Java Model constant representation (Number or String).static IMethod[]
findMethods(IMethod method, IMethod[] methods)
String[]
Returns the categories defined by this member's Javadoc.Returns the class file in which this member is declared, ornull
if this member is not declared in a class file (for example, a source type).Returns the type in which this member is declared, ornull
if this member is not declared in a type (for example, a top-level type).int
getFlags()
Returns the modifier flags for this member.getHandleFromMemento(String token, MementoTokenizer memento, WorkingCopyOwner workingCopyOwner)
protected char
Returns thechar
that marks the start of this handles contribution to a memento.Returns the Javadoc range if this element is from source or if this element is a binary element with an attached source, null otherwise.Returns the name range associated with this element.Returns the local or anonymous type declared in this source member with the given simple name and/or with the specified position relative to the order they are defined in the source.Returns the Java type root in which this member is declared.boolean
isBinary()
Returns whether this member is from a class file.protected boolean
isMainMethod(IMethod method)
boolean
Returns whether this Java element is read-only.Methods inherited from class org.aspectj.org.eclipse.jdt.internal.core.SourceRefElement
closing, copy, createElementInfo, delete, equals, findNode, generateInfos, getAnnotation, getAnnotations, getCompilationUnit, getCorrespondingResource, getHandleMemento, getHandleUpdatingCountFromMemento, getOccurrenceCount, getOpenableParent, getPath, getSource, getSourceRange, getUnderlyingResource, hasChildren, isStructureKnown, move, rename, resource, toStringName
Methods inherited from class org.aspectj.org.eclipse.jdt.internal.core.JavaElement
appendEscapedDelimiter, close, escapeMementoName, exists, getAncestor, getAttachedJavadoc, getChildren, getChildrenOfType, getElementInfo, getElementInfo, getElementName, getHandleFromMemento, getHandleIdentifier, getHandleMemento, getJavadocBaseLocation, getJavaModel, getJavaProject, getLibraryJavadocLocation, getOpenable, getParent, getPrimaryElement, getPrimaryElement, getResource, getSchedulingRule, getSourceElementAt, getSourceMapper, getURLContents, hashCode, isAncestorOf, newDoesNotExistStatus, newJavaModelException, newNotPresentException, openWhenClosed, 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
exists, getAncestor, getAttachedJavadoc, getCorrespondingResource, getElementName, getElementType, getHandleIdentifier, getJavaModel, getJavaProject, getOpenable, getParent, getPath, getPrimaryElement, getResource, getSchedulingRule, getUnderlyingResource, isStructureKnown
Methods inherited from interface org.aspectj.org.eclipse.jdt.core.IMember
getCompilationUnit, getOccurrenceCount
Methods inherited from interface org.aspectj.org.eclipse.jdt.core.IParent
getChildren, hasChildren
Methods inherited from interface org.aspectj.org.eclipse.jdt.core.ISourceManipulation
copy, delete, move, rename
Methods inherited from interface org.aspectj.org.eclipse.jdt.core.ISourceReference
exists, getSource, getSourceRange
-
Constructor Details
-
Member
-
-
Method Details
-
areSimilarMethods
-
convertConstant
Converts a field constant from the compiler's representation to the Java Model constant representation (Number or String). -
findMethods
-
getCategories
Description copied from interface:IMember
Returns the categories defined by this member's Javadoc. A category is the identifier following the tag@category
in the member's Javadoc. Returns an empty array if no category is defined in this member's Javadoc.- Specified by:
getCategories
in interfaceIMember
- Returns:
- the categories defined by this member's doc
- Throws:
JavaModelException
- if this element does not exist or if an exception occurs while accessing its corresponding resource.
-
getClassFile
Description copied from interface:IMember
Returns the class file in which this member is declared, ornull
if this member is not declared in a class file (for example, a source type). This is a handle-only method.- Specified by:
getClassFile
in interfaceIMember
- Overrides:
getClassFile
in classJavaElement
- Returns:
- the class file in which this member is declared, or
null
if this member is not declared in a class file (for example, a source type) - See Also:
IMember
-
getDeclaringType
Description copied from interface:IMember
Returns the type in which this member is declared, ornull
if this member is not declared in a type (for example, a top-level type). This is a handle-only method.- Specified by:
getDeclaringType
in interfaceIMember
- Returns:
- the type in which this member is declared, or
null
if this member is not declared in a type (for example, a top-level type) - See Also:
IMember
-
getFlags
Description copied from interface:IMember
Returns the modifier flags for this member. The flags can be examined using classFlags
.For binary members, flags from the class file as well as derived flags
Flags.AccAnnotationDefault
andFlags.AccDefaultMethod
are included.For source members, only flags as indicated in the source are returned. Thus if an interface defines a method
void myMethod();
, the flags don't include the 'public' flag. Source flags includeFlags.AccAnnotationDefault
as well.- Specified by:
getFlags
in interfaceIMember
- Returns:
- the modifier flags for this member
- Throws:
JavaModelException
- if this element does not exist or if an exception occurs while accessing its corresponding resource.- See Also:
IMember
-
getHandleFromMemento
public IJavaElement getHandleFromMemento(String token, MementoTokenizer memento, WorkingCopyOwner workingCopyOwner)- Overrides:
getHandleFromMemento
in classSourceRefElement
-
getHandleMementoDelimiter
protected char getHandleMementoDelimiter()Description copied from class:JavaElement
Returns thechar
that marks the start of this handles contribution to a memento.- Specified by:
getHandleMementoDelimiter
in classJavaElement
- See Also:
JavaElement.getHandleMemento()
-
getOuterMostLocalContext
-
getJavadocRange
Description copied from interface:IMember
Returns the Javadoc range if this element is from source or if this element is a binary element with an attached source, null otherwise.If this element is from source, the javadoc range is extracted from the corresponding source.
If this element is from a binary, the javadoc is extracted from the attached source if present.
If this element's openable is not consistent, then null is returned.
- Specified by:
getJavadocRange
in interfaceIMember
- Returns:
- a source range corresponding to the javadoc source or
null
if no source is available, this element has no javadoc comment or this element's openable is not consistent - Throws:
JavaModelException
- if this element does not exist or if an exception occurs while accessing its corresponding resource.- See Also:
IOpenable.isConsistent()
-
getNameRange
Description copied from interface:ISourceReference
Returns the name range associated with this element.If the element is an
IMember
, it returns the source range of this member's simple name, ornull
if this member does not have a name (for example, an initializer), or if this member does not have associated source code (for example, a binary type).If this element is an
IImportDeclaration
, the source range of this import declaration's name, ornull
if this import declaration does not have associated source code (for example, a binary type).
The source range for the name includes the trailing '*' if the call toIImportDeclaration.isOnDemand()
returns true.If this element is an
IPackageDeclaration
, the source range of this package declaration's name, ornull
if this package declaration does not have associated source code (for example, a binary type).If this element is an
IAnnotation
, the source range of this annotation's name, ornull
if this annotation does not have associated source code (for example, in a binary type).If this element is an
ITypeParameter
, the source range of this type parameter's name, ornull
if this type parameter does not have associated source code (for example, in a binary type).If this element is an
ITypeRoot
orIImportContainer
, it returns null.- Specified by:
getNameRange
in interfaceISourceReference
- Returns:
- the name range associated with this element, or
null
if not available - Throws:
JavaModelException
- See Also:
IMember
-
getType
Description copied from interface:IMember
Returns the local or anonymous type declared in this source member with the given simple name and/or with the specified position relative to the order they are defined in the source. The name is empty if it is an anonymous type. Numbering starts at 1 (thus the first occurrence is occurrence 1, not occurrence 0). This is a handle-only method. The type may or may not exist. Throws aRuntimeException
if this member is not a source member. -
getTypeRoot
Description copied from interface:IMember
Returns the Java type root in which this member is declared. This is a handle-only method.- Specified by:
getTypeRoot
in interfaceIMember
- Returns:
- the Java type root in which this member is declared.
- See Also:
IMember.getTypeRoot()
-
isBinary
public boolean isBinary()Description copied from interface:IMember
Returns whether this member is from a class file. This is a handle-only method. -
isMainMethod
- Throws:
JavaModelException
-
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 interfaceIJavaElement
- Overrides:
isReadOnly
in classJavaElement
- Returns:
true
if this element is read-only- See Also:
IJavaElement
-
readableName
- Overrides:
readableName
in classJavaElement
-