Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> eclipse >> jdt >> core >> [ dom overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.eclipse.jdt.core.dom
Class DoStatement  

java.lang.Object
  org.eclipse.jdt.core.dom.ASTNode
      org.eclipse.jdt.core.dom.Statement
          org.eclipse.jdt.core.dom.DoStatement

---

public class DoStatement

extends Statement

Do statement AST node type.

 DoStatement:
    do Statement while ( Expression ) ;
 

Since:

2.0

---

Nested Class Summary

 

Nested classes inherited from class org.eclipse.jdt.core.dom.ASTNode

ASTNode.NodeList

 

Field Summary
private  Statement	body           The body statement; lazily initialized; defaults to an empty block.
static ChildPropertyDescriptor	BODY_PROPERTY           The "body" structural property of this node type.
private  Expression	expression           The expression; lazily initialized; defaults to an unspecified, but legal, expression.
static ChildPropertyDescriptor	EXPRESSION_PROPERTY           The "expression" 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.

 

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

 

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)	DoStatement(AST ast)           Creates a new unparented do statement node 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.
Statement	getBody()           Returns the body of this do statement.
Expression	getExpression()           Returns the expression of this do statement.
(package private)  int	getNodeType0()           Returns an integer value identifying the type of this concrete AST node.
(package private)  ASTNode	internalGetSetChildProperty(ChildPropertyDescriptor property, boolean get, ASTNode child)           Sets the child 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	setBody(Statement statement)           Sets the body of this do statement.
void	setExpression(Expression expression)           Sets the expression of this do statement.
(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.Statement

copyLeadingComment, getLeadingComment, setLeadingComment

 

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, internalGetSetObjectProperty, 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

EXPRESSION_PROPERTY

public static final ChildPropertyDescriptor EXPRESSION_PROPERTY

The "expression" structural property of this node type.

Since:

3.0

---

BODY_PROPERTY

public static final ChildPropertyDescriptor BODY_PROPERTY

The "body" 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.

---

expression

private Expression expression

The expression; lazily initialized; defaults to an unspecified, but legal, expression.

---

body

private Statement body

The body statement; lazily initialized; defaults to an empty block.

Constructor Detail

DoStatement

DoStatement(AST ast)

Creates a new unparented do statement node owned by the given AST. By default, the expresssion is unspecified, but legal, and the body statement is an empty block.

N.B. This constructor is package-private.

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

---

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

---

getExpression

public Expression getExpression()

Returns the expression of this do statement.

---

setExpression

public void setExpression(Expression expression)

Sets the expression of this do statement.

---

getBody

public Statement getBody()

Returns the body of this do statement.

---

setBody

public void setBody(Statement statement)

Sets the body of this do statement.

Special note: The Java language does not allow a local variable declaration to appear as the body of a do statement (they may only appear within a block). However, the AST will allow a VariableDeclarationStatement as the body of a DoStatement. To get something that will compile, be sure to embed the VariableDeclarationStatement inside a Block.

---

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.

Overrides:

memSize in class Statement

---

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

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> eclipse >> jdt >> core >> [ dom overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---