org.eclipse.jdt.core.dom
Class SimpleName

java.lang.Object
  |
  +--org.eclipse.jdt.core.dom.ASTNode
        |
        +--org.eclipse.jdt.core.dom.Expression
              |
              +--org.eclipse.jdt.core.dom.Name
                    |
                    +--org.eclipse.jdt.core.dom.SimpleName

public class SimpleName

extends Name

AST node for a simple name. A simple name is an identifier other than a keyword, boolean literal ("true", "false") or null literal ("null").

Range 0: first character through last character of identifier.

 SimpleName:
     Identifier
 

Since:

2.0

Field Summary

Fields inherited from class org.eclipse.jdt.core.dom.ASTNode

ANONYMOUS_CLASS_DECLARATION, ARRAY_ACCESS, ARRAY_CREATION, ARRAY_INITIALIZER, ARRAY_TYPE, ASSERT_STATEMENT, ASSIGNMENT, BLOCK, BOOLEAN_LITERAL, BREAK_STATEMENT, CAST_EXPRESSION, CATCH_CLAUSE, CHARACTER_LITERAL, CLASS_INSTANCE_CREATION, COMPILATION_UNIT, CONDITIONAL_EXPRESSION, CONSTRUCTOR_INVOCATION, CONTINUE_STATEMENT, DO_STATEMENT, EMPTY_STATEMENT, EXPRESSION_STATEMENT, FIELD_ACCESS, FIELD_DECLARATION, FOR_STATEMENT, IF_STATEMENT, IMPORT_DECLARATION, INFIX_EXPRESSION, INITIALIZER, INSTANCEOF_EXPRESSION, JAVADOC, LABELED_STATEMENT, MALFORMED, METHOD_DECLARATION, METHOD_INVOCATION, NULL_LITERAL, NUMBER_LITERAL, PACKAGE_DECLARATION, PARENTHESIZED_EXPRESSION, POSTFIX_EXPRESSION, PREFIX_EXPRESSION, PRIMITIVE_TYPE, QUALIFIED_NAME, RETURN_STATEMENT, SIMPLE_NAME, SIMPLE_TYPE, SINGLE_VARIABLE_DECLARATION, STRING_LITERAL, SUPER_CONSTRUCTOR_INVOCATION, SUPER_FIELD_ACCESS, SUPER_METHOD_INVOCATION, SWITCH_CASE, SWITCH_STATEMENT, SYNCHRONIZED_STATEMENT, THIS_EXPRESSION, THROW_STATEMENT, TRY_STATEMENT, TYPE_DECLARATION, TYPE_DECLARATION_STATEMENT, TYPE_LITERAL, VARIABLE_DECLARATION_EXPRESSION, VARIABLE_DECLARATION_FRAGMENT, VARIABLE_DECLARATION_STATEMENT, WHILE_STATEMENT

Method Summary

String	getIdentifier() Returns this node's identifier.
int	getNodeType() Returns an integer value identifying the type of this concrete AST node.
boolean	isDeclaration() Returns whether this simple name represents a name that is being defined, as opposed to one being referenced.
void	setIdentifier(String identifier) Sets the identifier of this node to the given value.
boolean	subtreeMatch(ASTMatcher matcher, Object other) Returns whether the subtree rooted at the given node matches the given other object as decided by the given matcher.

Methods inherited from class org.eclipse.jdt.core.dom.Name

isQualifiedName, isSimpleName, resolveBinding

Methods inherited from class org.eclipse.jdt.core.dom.Expression

resolveTypeBinding

Methods inherited from class org.eclipse.jdt.core.dom.ASTNode

accept, copySubtree, copySubtrees, equals, getAST, getFlags, getLength, getParent, getProperty, getRoot, getStartPosition, properties, setFlags, setProperty, setSourceRange, subtreeBytes, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getNodeType

public int getNodeType()

Description copied from class: ASTNode

Returns an integer value identifying the type of this concrete AST node. The values are small positive integers, suitable for use in switch statements.

For each concrete node type there is a unique node type constant (name and value). The unique node type constant for a concrete node type such as CastExpression is ASTNode.CAST_EXPRESSION.

Specified by:

getNodeType in class ASTNode

Returns:

one of the node type constants

subtreeMatch

public boolean subtreeMatch(ASTMatcher matcher,
                            Object other)

Description copied from class: ASTNode

Returns whether the subtree rooted at the given node matches the given other object as decided by the given matcher.

Specified by:

subtreeMatch in class ASTNode

Parameters:

matcher - the matcher

other - the other object, or null

Returns:

true if the subtree matches, or false if they do not match

getIdentifier

public String getIdentifier()

Returns this node's identifier.

Returns:

the identifier of this node

setIdentifier

public void setIdentifier(String identifier)

Sets the identifier of this node to the given value. The identifier should be legal according to the rules of the Java language. Note that keywords are not legal identifiers.

Note that the list of keywords may depend on the version of the language (determined when the AST object was created).

Parameters:

identifier - the identifier of this node

Throws:

IllegalArgumentException - if the identifier is invalid

See Also:

AST.AST(java.util.Map)

isDeclaration

public boolean isDeclaration()

Returns whether this simple name represents a name that is being defined, as opposed to one being referenced. The following positions are considered ones where a name is defined:

• The type name in a TypeDeclaration node.
• The method name in a MethodDeclaration node providing isConstructor is false.
• The variable name in any type of VariableDeclaration node.

Note that this is a convenience method that simply checks whether this node appears in the declaration position relative to its parent. It always returns false if this node is unparented.

Returns:

true if this node declares a name, and false otherwise