Package org.eclipse.cdt.core.dom.ast

Interface IASTWhileStatement

All Superinterfaces:

IASTAttributeOwner, IASTNode, IASTStatement

All Known Subinterfaces:

ICPPASTWhileStatement

public interface IASTWhileStatement
extends IASTStatement

Ye ol' while statement.

Restriction:

This interface is not intended to be implemented by clients.

Restriction:

This interface is not intended to be extended by clients.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.cdt.core.dom.ast.IASTNode

IASTNode.CopyStyle

Field Summary

Fields

Modifier and Type	Field	Description
static ASTNodeProperty	BODY	BODY represents the relationship between an IASTWhileStatement and it's nested IASTStatement.
static ASTNodeProperty	CONDITIONEXPRESSION	CONDITIONEXPRESSION represents the relationship between an IASTWhileStatement and it's nested IASTExpression.

Fields inherited from interface org.eclipse.cdt.core.dom.ast.IASTAttributeOwner

ATTRIBUTE, ATTRIBUTE_SPECIFIER

Fields inherited from interface org.eclipse.cdt.core.dom.ast.IASTNode

EMPTY_NODE_ARRAY

Fields inherited from interface org.eclipse.cdt.core.dom.ast.IASTStatement

EMPTY_STATEMENT_ARRAY

Method Summary

Modifier and Type	Method	Description
IASTWhileStatement	copy()	Returns a mutable copy of the tree rooted at this node.
IASTWhileStatement	copy(IASTNode.CopyStyle style)	Returns a mutable copy of the tree rooted at this node.
IASTStatement	getBody()	The body of the loop.
IASTExpression	getCondition()	Returns the condition on the while loop
void	setBody(IASTStatement body)	Sets the body of the while loop.
void	setCondition(IASTExpression condition)	Sets the condition of the while loop.

Methods inherited from interface org.eclipse.cdt.core.dom.ast.IASTAttributeOwner

addAttribute, addAttributeSpecifier, getAttributes, getAttributeSpecifiers

Methods inherited from interface org.eclipse.cdt.core.dom.ast.IASTNode

accept, contains, getChildren, getContainingFilename, getFileLocation, getLeadingSyntax, getNodeLocations, getOriginalNode, getParent, getPropertyInParent, getRawSignature, getSyntax, getTrailingSyntax, getTranslationUnit, isActive, isFrozen, isPartOfTranslationUnitFile, setParent, setPropertyInParent

Field Detail

CONDITIONEXPRESSION

static final ASTNodeProperty CONDITIONEXPRESSION

CONDITIONEXPRESSION represents the relationship between an IASTWhileStatement and it's nested IASTExpression.

BODY

static final ASTNodeProperty BODY

BODY represents the relationship between an IASTWhileStatement and it's nested IASTStatement.

Method Detail

getCondition

IASTExpression getCondition()

Returns the condition on the while loop

Returns:

expression for the condition

setCondition

void setCondition(IASTExpression condition)

Sets the condition of the while loop.

Parameters:

condition -

getBody

IASTStatement getBody()

The body of the loop.

Returns:

the body

setBody

void setBody(IASTStatement body)

Sets the body of the while loop.

Parameters:

body -

copy

IASTWhileStatement copy()

Description copied from interface: IASTNode

Returns a mutable copy of the tree rooted at this node. The following postconditions hold:

 copy.getParent() == null
 copy.getPropertyInParent() == null
 copy.isFrozen() == false
 

Preprocessor nodes do not currently support being copied. Implicit name nodes are not copied, instead they can be regenerated if required.

Calling this method is equivalent to copy(CopyStyle.withoutLocations).

Specified by:

copy in interface IASTNode

Specified by:

copy in interface IASTStatement

Since:

5.1

copy

IASTWhileStatement copy(IASTNode.CopyStyle style)

Description copied from interface: IASTNode

Returns a mutable copy of the tree rooted at this node. The following postconditions hold:

 copy.getParent() == null
 copy.getPropertyInParent() == null
 copy.isFrozen() == false
 

Preprocessor nodes do not currently support being copied. Implicit name nodes are not copied, instead they can be regenerated if required.

Specified by:

copy in interface IASTNode

Specified by:

copy in interface IASTStatement

Parameters:

style - IASTNode.CopyStyle create a copy with or without locations. Please see IASTNode.CopyStyle for restrictions on copies with Locations.

Since:

5.3