Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.eclipse.jdt.core.dom
Class Assignment  view Assignment download Assignment.java

java.lang.Object
  extended byorg.eclipse.jdt.core.dom.ASTNode
      extended byorg.eclipse.jdt.core.dom.Expression
          extended byorg.eclipse.jdt.core.dom.Assignment

public class Assignment
extends Expression

Assignment expression AST node type.

 Assignment:
    Expression AssignmentOperator Expression
 

Since:
2.0

Nested Class Summary
static class Assignment.Operator
          Assignment operators (typesafe enumeration).
 
Nested classes inherited from class org.eclipse.jdt.core.dom.ASTNode
ASTNode.NodeList
 
Field Summary
private  Assignment.Operator assignmentOperator
          The assignment operator; defaults to Assignment.Operator.ASSIGN
static ChildPropertyDescriptor LEFT_HAND_SIDE_PROPERTY
          The "leftHandSide" structural property of this node type.
private  Expression leftHandSide
          The left hand side; lazily initialized; defaults to an unspecified, but legal, simple name.
static SimplePropertyDescriptor OPERATOR_PROPERTY
          The "operator" structural property of this node type.
private static java.util.List PROPERTY_DESCRIPTORS
          A list of property descriptors (element type: StructuralPropertyDescriptor), or null if uninitialized.
static ChildPropertyDescriptor RIGHT_HAND_SIDE_PROPERTY
          The "rightHandSide" structural property of this node type.
private  Expression rightHandSide
          The right hand side; lazily initialized; defaults to an unspecified, but legal, simple name.
 
Fields inherited from class org.eclipse.jdt.core.dom.ASTNode
ANNOTATION_TYPE_DECLARATION, ANNOTATION_TYPE_MEMBER_DECLARATION, ANONYMOUS_CLASS_DECLARATION, ARRAY_ACCESS, ARRAY_CREATION, ARRAY_INITIALIZER, ARRAY_TYPE, ASSERT_STATEMENT, ASSIGNMENT, ast, BASE_NODE_SIZE, BLOCK, BLOCK_COMMENT, BOOLEAN_LITERAL, BREAK_STATEMENT, CAST_EXPRESSION, CATCH_CLAUSE, CHARACTER_LITERAL, CLASS_INSTANCE_CREATION, COMPILATION_UNIT, CONDITIONAL_EXPRESSION, CONSTRUCTOR_INVOCATION, CONTINUE_STATEMENT, CYCLE_RISK, DO_STATEMENT, EMPTY_STATEMENT, ENHANCED_FOR_STATEMENT, ENUM_CONSTANT_DECLARATION, ENUM_DECLARATION, EXPRESSION_STATEMENT, FIELD_ACCESS, FIELD_DECLARATION, FOR_STATEMENT, HEADERS, IF_STATEMENT, IMPORT_DECLARATION, INFIX_EXPRESSION, INITIALIZER, INSTANCEOF_EXPRESSION, JAVADOC, LABELED_STATEMENT, LINE_COMMENT, MALFORMED, MANDATORY, MARKER_ANNOTATION, MEMBER_REF, MEMBER_VALUE_PAIR, METHOD_DECLARATION, METHOD_INVOCATION, METHOD_REF, METHOD_REF_PARAMETER, MODIFIER, NO_CYCLE_RISK, NORMAL_ANNOTATION, NULL_LITERAL, NUMBER_LITERAL, OPTIONAL, ORIGINAL, PACKAGE_DECLARATION, PARAMETERIZED_TYPE, PARENTHESIZED_EXPRESSION, POSTFIX_EXPRESSION, PREFIX_EXPRESSION, PRIMITIVE_TYPE, PROTECT, QUALIFIED_NAME, QUALIFIED_TYPE, RETURN_STATEMENT, SIMPLE_NAME, SIMPLE_TYPE, SINGLE_MEMBER_ANNOTATION, SINGLE_VARIABLE_DECLARATION, STRING_LITERAL, SUPER_CONSTRUCTOR_INVOCATION, SUPER_FIELD_ACCESS, SUPER_METHOD_INVOCATION, SWITCH_CASE, SWITCH_STATEMENT, SYNCHRONIZED_STATEMENT, TAG_ELEMENT, TEXT_ELEMENT, THIS_EXPRESSION, THROW_STATEMENT, TRY_STATEMENT, TYPE_DECLARATION, TYPE_DECLARATION_STATEMENT, TYPE_LITERAL, TYPE_PARAMETER, typeAndFlags, VARIABLE_DECLARATION_EXPRESSION, VARIABLE_DECLARATION_FRAGMENT, VARIABLE_DECLARATION_STATEMENT, WHILE_STATEMENT, WILDCARD_TYPE
 
Constructor Summary
(package private) Assignment(AST ast)
          Creates a new AST node for an assignment expression owned by the given AST.
 
Method Summary
(package private)  void accept0(ASTVisitor visitor)
          Accepts the given visitor on a type-specific visit of the current node.
(package private)  ASTNode clone0(AST target)
          Returns a deep copy of the subtree of AST nodes rooted at this node.
 Expression getLeftHandSide()
          Returns the left hand side of this assignment expression.
(package private)  int getNodeType0()
          Returns an integer value identifying the type of this concrete AST node.
 Assignment.Operator getOperator()
          Returns the operator of this assignment expression.
 Expression getRightHandSide()
          Returns the right hand side of this assignment expression.
(package private)  ASTNode internalGetSetChildProperty(ChildPropertyDescriptor property, boolean get, ASTNode child)
          Sets the child value of the given property for this node.
(package private)  java.lang.Object internalGetSetObjectProperty(SimplePropertyDescriptor property, boolean get, java.lang.Object value)
          Sets the value of the given property for this node.
(package private)  java.util.List internalStructuralPropertiesForType(int apiLevel)
          Returns a list of property descriptors for this node type.
(package private)  int memSize()
          Returns an estimate of the memory footprint of this node in bytes.
static java.util.List propertyDescriptors(int apiLevel)
          Returns a list of structural property descriptors for this node type.
 void setLeftHandSide(Expression expression)
          Sets the left hand side of this assignment expression.
 void setOperator(Assignment.Operator assignmentOperator)
          Sets the operator of this assignment expression.
 void setRightHandSide(Expression expression)
          Sets the right hand side of this assignment expression.
(package private)  boolean subtreeMatch0(ASTMatcher matcher, java.lang.Object other)
          Returns whether the subtree rooted at the given node matches the given other object as decided by the given matcher.
(package private)  int treeSize()
          Returns an estimate of the memory footprint in bytes of the entire subtree rooted at this node.
 
Methods inherited from class org.eclipse.jdt.core.dom.Expression
resolveTypeBinding
 
Methods inherited from class org.eclipse.jdt.core.dom.ASTNode
accept, acceptChild, acceptChildren, addProperty, appendDebugString, appendPrintString, checkModifiable, checkNewChild, clone, copySubtree, copySubtrees, createPropertyList, delete, equals, getAST, getFlags, getLength, getLocationInParent, getNodeType, getParent, getProperty, getRoot, getStartPosition, getStructuralProperty, internalGetChildListProperty, internalGetSetBooleanProperty, internalGetSetIntProperty, nodeClassForType, postLazyInit, postReplaceChild, postValueChange, preLazyInit, preReplaceChild, preValueChange, properties, reapPropertyList, setFlags, setParent, setProperty, setSourceRange, setStructuralProperty, standardToString, stringSize, structuralPropertiesForType, subtreeBytes, subtreeMatch, supportedOnlyIn2, toString, unsupportedIn2
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

LEFT_HAND_SIDE_PROPERTY

public static final ChildPropertyDescriptor LEFT_HAND_SIDE_PROPERTY
The "leftHandSide" structural property of this node type.

Since:
3.0

OPERATOR_PROPERTY

public static final SimplePropertyDescriptor OPERATOR_PROPERTY
The "operator" structural property of this node type.

Since:
3.0

RIGHT_HAND_SIDE_PROPERTY

public static final ChildPropertyDescriptor RIGHT_HAND_SIDE_PROPERTY
The "rightHandSide" structural property of this node type.

Since:
3.0

PROPERTY_DESCRIPTORS

private static final java.util.List PROPERTY_DESCRIPTORS
A list of property descriptors (element type: StructuralPropertyDescriptor), or null if uninitialized.


assignmentOperator

private Assignment.Operator assignmentOperator
The assignment operator; defaults to Assignment.Operator.ASSIGN


leftHandSide

private Expression leftHandSide
The left hand side; lazily initialized; defaults to an unspecified, but legal, simple name.


rightHandSide

private Expression rightHandSide
The right hand side; lazily initialized; defaults to an unspecified, but legal, simple name.

Constructor Detail

Assignment

Assignment(AST ast)
Creates a new AST node for an assignment expression owned by the given AST. By default, the node has an assignment operator, and unspecified left and right hand sides.

Method Detail

propertyDescriptors

public static java.util.List propertyDescriptors(int apiLevel)
Returns a list of structural property descriptors for this node type. Clients must not modify the result.

Since:
3.0

internalStructuralPropertiesForType

final java.util.List internalStructuralPropertiesForType(int apiLevel)
Description copied from class: ASTNode
Returns a list of property descriptors for this node type. Clients must not modify the result. This abstract method must be implemented in each concrete AST node type.

N.B. This method is package-private, so that the implementations of this method in each of the concrete AST node types do not clutter up the API doc.

Specified by:
internalStructuralPropertiesForType in class ASTNode

internalGetSetObjectProperty

final java.lang.Object internalGetSetObjectProperty(SimplePropertyDescriptor property,
                                                    boolean get,
                                                    java.lang.Object value)
Description copied from class: ASTNode
Sets the value of the given property for this node. The default implementation of this method throws an exception explaining that this node does not have such a property. This method should be extended in subclasses that have at leasy one simple property whose value type is a reference type.

Overrides:
internalGetSetObjectProperty in class ASTNode

internalGetSetChildProperty

final ASTNode internalGetSetChildProperty(ChildPropertyDescriptor property,
                                          boolean get,
                                          ASTNode child)
Description copied from class: ASTNode
Sets the child value of the given property for this node. The default implementation of this method throws an exception explaining that this node does not have such a property. This method should be extended in subclasses that have at leasy one child property.

Overrides:
internalGetSetChildProperty in class ASTNode

getNodeType0

final int getNodeType0()
Description copied from class: ASTNode
Returns an integer value identifying the type of this concrete AST node.

This internal method is implemented in each of the concrete node subclasses.

Specified by:
getNodeType0 in class ASTNode

clone0

ASTNode clone0(AST target)
Description copied from class: ASTNode
Returns a deep copy of the subtree of AST nodes rooted at this node. The resulting nodes are owned by the given AST, which may be different from the AST of this node. Even if this node has a parent, the result node will be unparented.

This method must be implemented in subclasses.

This method does not report pre- and post-clone events. All callers should instead call clone(AST) to ensure that pre- and post-clone events are reported.

N.B. This method is package-private, so that the implementations of this method in each of the concrete AST node types do not clutter up the API doc.

Specified by:
clone0 in class ASTNode

subtreeMatch0

final boolean subtreeMatch0(ASTMatcher matcher,
                            java.lang.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.

This internal method is implemented in each of the concrete node subclasses.

Specified by:
subtreeMatch0 in class ASTNode

accept0

void accept0(ASTVisitor visitor)
Description copied from class: ASTNode
Accepts the given visitor on a type-specific visit of the current node. This method must be implemented in all concrete AST node types.

General template for implementation on each concrete ASTNode class:

 
 boolean visitChildren = visitor.visit(this);
 if (visitChildren) {
    // visit children in normal left to right reading order
    acceptChild(visitor, getProperty1());
    acceptChildren(visitor, rawListProperty);
    acceptChild(visitor, getProperty2());
 }
 visitor.endVisit(this);
 
 
Note that the caller (accept) take cares of invoking visitor.preVisit(this) and visitor.postVisit(this).

Specified by:
accept0 in class ASTNode

getOperator

public Assignment.Operator getOperator()
Returns the operator of this assignment expression.


setOperator

public void setOperator(Assignment.Operator assignmentOperator)
Sets the operator of this assignment expression.


getLeftHandSide

public Expression getLeftHandSide()
Returns the left hand side of this assignment expression.


setLeftHandSide

public void setLeftHandSide(Expression expression)
Sets the left hand side of this assignment expression.


getRightHandSide

public Expression getRightHandSide()
Returns the right hand side of this assignment expression.


setRightHandSide

public void setRightHandSide(Expression expression)
Sets the right hand side of this assignment expression.


memSize

int memSize()
Description copied from class: ASTNode
Returns an estimate of the memory footprint of this node in bytes. The estimate does not include the space occupied by child nodes.

Specified by:
memSize in class ASTNode

treeSize

int treeSize()
Description copied from class: ASTNode
Returns an estimate of the memory footprint in bytes of the entire subtree rooted at this node.

N.B. This method is package-private, so that the implementations of this method in each of the concrete AST node types do not clutter up the API doc.

Specified by:
treeSize in class ASTNode