Class CommentsPreparator

java.lang.Object
org.aspectj.org.eclipse.jdt.core.dom.ASTVisitor
org.aspectj.org.eclipse.jdt.internal.formatter.CommentsPreparator
public class CommentsPreparator extends ASTVisitor

  • Field Details

    • COMMENT_LINE_SEPARATOR_LENGTH

      public static final int COMMENT_LINE_SEPARATOR_LENGTH
      See Also:

  • Constructor Details

  • Method Details

    • preVisit2

      public boolean preVisit2(ASTNode node)
      Description copied from class: ASTVisitor
      Visits the given AST node prior to the type-specific visit (before visit).

      The default implementation calls ASTVisitor.preVisit(ASTNode) and then returns true. Subclasses may reimplement.

      Overrides:
      preVisit2 in class ASTVisitor
      Parameters:
      node - the node to visit
      Returns:
      true if visit(node) should be called, and false otherwise.
      See Also:

    • visit

      public boolean visit(LineComment node)
      Description copied from class: ASTVisitor
      Visits the given type-specific AST node.

      The default implementation does nothing and return true. Subclasses may reimplement.

      Note: LineComment and BlockComment nodes are not considered part of main structure of the AST. This method will only be called if a client goes out of their way to visit this kind of node explicitly.

      Overrides:
      visit in class ASTVisitor
      Parameters:
      node - the node to visit
      Returns:
      true if the children of this node should be visited, and false if the children of this node should be skipped

    • handleLineComment

      public void handleLineComment(int commentIndex)

    • visit

      public boolean visit(BlockComment node)
      Description copied from class: ASTVisitor
      Visits the given type-specific AST node.

      The default implementation does nothing and return true. Subclasses may reimplement.

      Note: LineComment and BlockComment nodes are not considered part of main structure of the AST. This method will only be called if a client goes out of their way to visit this kind of node explicitly.

      Overrides:
      visit in class ASTVisitor
      Parameters:
      node - the node to visit
      Returns:
      true if the children of this node should be visited, and false if the children of this node should be skipped

    • handleBlockComment

      public void handleBlockComment(int commentIndex)

    • visit

      public boolean visit(Javadoc node)
      Description copied from class: ASTVisitor
      Visits the given AST node.

      Unlike other node types, the boolean returned by the default implementation is controlled by a constructor-supplied parameter ASTVisitor(boolean) which is false by default. Subclasses may reimplement.

      Overrides:
      visit in class ASTVisitor
      Parameters:
      node - the node to visit
      Returns:
      true if the children of this node should be visited, and false if the children of this node should be skipped
      See Also:

    • endVisit

      public void endVisit(Javadoc node)
      Description copied from class: ASTVisitor
      End of visit the given type-specific AST node.

      The default implementation does nothing. Subclasses may reimplement.

      Overrides:
      endVisit in class ASTVisitor
      Parameters:
      node - the node to visit

    • visit

      public boolean visit(TagElement node)
      Description copied from class: ASTVisitor
      Visits the given type-specific AST node.

      The default implementation does nothing and return true. Subclasses may reimplement.

      Overrides:
      visit in class ASTVisitor
      Parameters:
      node - the node to visit
      Returns:
      true if the children of this node should be visited, and false if the children of this node should be skipped

    • endVisit

      public void endVisit(TagElement node)
      Description copied from class: ASTVisitor
      End of visit the given type-specific AST node.

      The default implementation does nothing. Subclasses may reimplement.

      Overrides:
      endVisit in class ASTVisitor
      Parameters:
      node - the node to visit

    • visit

      public boolean visit(MethodRef node)
      Description copied from class: ASTVisitor
      Visits the given type-specific AST node.

      The default implementation does nothing and return true. Subclasses may reimplement.

      Overrides:
      visit in class ASTVisitor
      Parameters:
      node - the node to visit
      Returns:
      true if the children of this node should be visited, and false if the children of this node should be skipped

    • visit

      public boolean visit(MemberRef node)
      Description copied from class: ASTVisitor
      Visits the given type-specific AST node.

      The default implementation does nothing and return true. Subclasses may reimplement.

      Overrides:
      visit in class ASTVisitor
      Parameters:
      node - the node to visit
      Returns:
      true if the children of this node should be visited, and false if the children of this node should be skipped

    • visit

      public boolean visit(QualifiedName node)
      Description copied from class: ASTVisitor
      Visits the given type-specific AST node.

      The default implementation does nothing and return true. Subclasses may reimplement.

      Overrides:
      visit in class ASTVisitor
      Parameters:
      node - the node to visit
      Returns:
      true if the children of this node should be visited, and false if the children of this node should be skipped

    • finishUp

      public void finishUp()