org.sonar.java.ast.visitors
Class PublicApiVisitor

java.lang.Object
  com.sonar.sslr.squid.SquidAstVisitor<G>
      com.sonar.sslr.squid.checks.SquidCheck<org.sonar.sslr.parser.LexerlessGrammar>
          org.sonar.java.ast.visitors.PublicApiVisitor

All Implemented Interfaces:

com.sonar.sslr.api.AstVisitor, org.sonar.squid.api.CodeCheck, org.sonar.squid.api.CodeVisitor

public class PublicApiVisitor
extends com.sonar.sslr.squid.checks.SquidCheck<org.sonar.sslr.parser.LexerlessGrammar>

Constructor Summary

PublicApiVisitor()

Method Summary

static String	getApiJavadoc(com.sonar.sslr.api.AstNode astNode)
static com.sonar.sslr.api.AstNode	getDeclaration(com.sonar.sslr.api.AstNode astNode)
static String	getType(com.sonar.sslr.api.AstNode node)
void	init()
static boolean	isDocumentedApi(com.sonar.sslr.api.AstNode astNode)
static boolean	isPublicApi(com.sonar.sslr.api.AstNode astNode)
static void	subscribe(com.sonar.sslr.squid.checks.SquidCheck<org.sonar.sslr.parser.LexerlessGrammar> visitor)
void	visitNode(com.sonar.sslr.api.AstNode astNode)

Methods inherited from class com.sonar.sslr.squid.checks.SquidCheck

getKey

Methods inherited from class com.sonar.sslr.squid.SquidAstVisitor

destroy, getAstNodeTypesToVisit, getContext, leaveFile, leaveNode, setContext, subscribeTo, visitFile

Methods inherited from class java.lang.Object

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

Constructor Detail

PublicApiVisitor

public PublicApiVisitor()

Method Detail

init

public void init()

Overrides:

init in class com.sonar.sslr.squid.SquidAstVisitor<org.sonar.sslr.parser.LexerlessGrammar>

subscribe

public static void subscribe(com.sonar.sslr.squid.checks.SquidCheck<org.sonar.sslr.parser.LexerlessGrammar> visitor)

visitNode

public void visitNode(com.sonar.sslr.api.AstNode astNode)

Specified by:

visitNode in interface com.sonar.sslr.api.AstVisitor

Overrides:

visitNode in class com.sonar.sslr.squid.SquidAstVisitor<org.sonar.sslr.parser.LexerlessGrammar>

isPublicApi

public static boolean isPublicApi(com.sonar.sslr.api.AstNode astNode)

getType

public static String getType(com.sonar.sslr.api.AstNode node)

isDocumentedApi

public static boolean isDocumentedApi(com.sonar.sslr.api.AstNode astNode)

getApiJavadoc

public static String getApiJavadoc(com.sonar.sslr.api.AstNode astNode)

getDeclaration

public static com.sonar.sslr.api.AstNode getDeclaration(com.sonar.sslr.api.AstNode astNode)