Package org.aspectj.org.eclipse.jdt.internal.formatter

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 Summary

Fields

Modifier and Type	Field	Description
static final int	COMMENT_LINE_SEPARATOR_LENGTH

Constructor Summary

Constructors

Constructor	Description
CommentsPreparator(TokenManager tm, DefaultCodeFormatterOptions options, String sourceLevel)

Method Summary

Modifier and Type	Method	Description
void	endVisit(Javadoc node)	End of visit the given type-specific AST node.
void	endVisit(TagElement node)	End of visit the given type-specific AST node.
void	finishUp()
void	handleBlockComment(int commentIndex)
void	handleLineComment(int commentIndex)
boolean	preVisit2(ASTNode node)	Visits the given AST node prior to the type-specific visit (before visit).
boolean	visit(BlockComment node)	Visits the given type-specific AST node.
boolean	visit(Javadoc node)	Visits the given AST node.
boolean	visit(LineComment node)	Visits the given type-specific AST node.
boolean	visit(MemberRef node)	Visits the given type-specific AST node.
boolean	visit(MethodRef node)	Visits the given type-specific AST node.
boolean	visit(QualifiedName node)	Visits the given type-specific AST node.
boolean	visit(TagElement node)	Visits the given type-specific AST node.

Methods inherited from class org.aspectj.org.eclipse.jdt.core.dom.ASTVisitor

endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, endVisit, postVisit, preVisit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

COMMENT_LINE_SEPARATOR_LENGTH

public static final int COMMENT_LINE_SEPARATOR_LENGTH

See Also:

• Constant Field Values

Constructor Details

CommentsPreparator

public CommentsPreparator(TokenManager tm,
 DefaultCodeFormatterOptions options,
 String sourceLevel)

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:

• ASTVisitor.preVisit(ASTNode)

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:

• ASTVisitor()
• ASTVisitor(boolean)

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()