org.sonar.java.ast.visitors

Class PublicApiChecker

java.lang.Object

org.sonar.plugins.java.api.tree.BaseTreeVisitor

org.sonar.java.ast.visitors.PublicApiChecker

All Implemented Interfaces:

TreeVisitor

public class PublicApiChecker
extends BaseTreeVisitor

Method Summary

Methods

Modifier and Type	Method and Description
static Tree.Kind[]	apiKinds()
static Tree.Kind[]	classKinds()
static String	getApiJavadoc(Tree tree)
double	getDocumentedPublicApiDensity()
double	getPublicApi()
double	getUndocumentedPublicApi()
boolean	isPublicApi(Tree currentParent, Tree tree)
static Tree.Kind[]	methodKinds()
static PublicApiChecker	newInstanceWithAccessorsHandledAsMethods()
static PublicApiChecker	newInstanceWithAccessorsSeparatedFromMethods()
void	scan(CompilationUnitTree tree)
void	visitClass(ClassTree tree)
void	visitMethod(MethodTree tree)
void	visitNewClass(NewClassTree tree)
void	visitVariable(VariableTree tree)

Methods inherited from class org.sonar.plugins.java.api.tree.BaseTreeVisitor

scan, scan, scan, visitAnnotation, visitArrayAccessExpression, visitArrayDimension, visitArrayType, visitAssertStatement, visitAssignmentExpression, visitBinaryExpression, visitBlock, visitBreakStatement, visitCaseGroup, visitCaseLabel, visitCatch, visitCompilationUnit, visitConditionalExpression, visitContinueStatement, visitDoWhileStatement, visitEmptyStatement, visitEnumConstant, visitExpressionStatement, visitForEachStatement, visitForStatement, visitIdentifier, visitIfStatement, visitImport, visitInstanceOf, visitLabeledStatement, visitLambdaExpression, visitLiteral, visitMemberSelectExpression, visitMethodInvocation, visitMethodReference, visitModifier, visitNewArray, visitOther, visitPackage, visitParameterizedType, visitParenthesized, visitPrimitiveType, visitReturnStatement, visitSwitchStatement, visitSynchronizedStatement, visitThrowStatement, visitTryStatement, visitTypeArguments, visitTypeCast, visitTypeParameter, visitTypeParameters, visitUnaryExpression, visitUnionType, visitWhileStatement, visitWildcard

Methods inherited from class java.lang.Object

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

Method Detail

newInstanceWithAccessorsHandledAsMethods

public static PublicApiChecker newInstanceWithAccessorsHandledAsMethods()

newInstanceWithAccessorsSeparatedFromMethods

public static PublicApiChecker newInstanceWithAccessorsSeparatedFromMethods()

classKinds

public static Tree.Kind[] classKinds()

methodKinds

public static Tree.Kind[] methodKinds()

apiKinds

public static Tree.Kind[] apiKinds()

scan

public void scan(CompilationUnitTree tree)

visitNewClass

public void visitNewClass(NewClassTree tree)

Specified by:

visitNewClass in interface TreeVisitor

Overrides:

visitNewClass in class BaseTreeVisitor

visitClass

public void visitClass(ClassTree tree)

Specified by:

visitClass in interface TreeVisitor

Overrides:

visitClass in class BaseTreeVisitor

visitVariable

public void visitVariable(VariableTree tree)

Specified by:

visitVariable in interface TreeVisitor

Overrides:

visitVariable in class BaseTreeVisitor

visitMethod

public void visitMethod(MethodTree tree)

Specified by:

visitMethod in interface TreeVisitor

Overrides:

visitMethod in class BaseTreeVisitor

isPublicApi

public boolean isPublicApi(Tree currentParent,
                  Tree tree)

getApiJavadoc

@Nullable
public static String getApiJavadoc(Tree tree)

getPublicApi

public double getPublicApi()

getUndocumentedPublicApi

public double getUndocumentedPublicApi()

getDocumentedPublicApiDensity

public double getDocumentedPublicApiDensity()