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.

  • Field Details

    • 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 Details

    • 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