com.puppycrawl.tools.checkstyle.checks.annotation

クラス PackageAnnotationCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.Check

com.puppycrawl.tools.checkstyle.checks.annotation.PackageAnnotationCheck

すべての実装されたインタフェース:

Configurable, Contextualizable

public class PackageAnnotationCheck
extends Check

This check makes sure that all package annotations are in the package-info.java file.

According to the Java JLS 3rd ed.

The JLS does not enforce the placement of package annotations. This placement may vary based on implementation. The JLS does highly recommend that all package annotations are placed in the package-info.java file. See Java Language specification, sections 7.4.1.1.

作成者:

Travis Schneeberger

フィールドの概要

クラスから継承されたフィールド com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

DEFAULT_ERROR_SCORE, DEFAULT_INFO_SCORE, DEFAULT_WARNING_SCORE, mScoring, mViolationSize

コンストラクタの概要

コンストラクタ

コンストラクタと説明
PackageAnnotationCheck()

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
int[]	getAcceptableTokens() The configurable token set.
int[]	getDefaultTokens() Returns the default token a check is interested in.
int[]	getRequiredTokens() The tokens that this check must be registered for.
void	visitToken(DetailAST aAST) Called to process a token.

クラスから継承されたメソッド com.puppycrawl.tools.checkstyle.api.Check

beginTree, destroy, finishTree, getClassLoader, getFileContents, getLines, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

クラスから継承されたメソッド com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

calculateScore, getCustomMessages, getErrorScore, getId, getInfoScore, getMessageBundle, getScore, getScoring, getSeverity, getSeverityLevel, getWarningScore, log, setErrorScore, setId, setInfoScore, setScore, setScoring, setSeverity, setWarningScore

クラスから継承されたメソッド com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

PackageAnnotationCheck

public PackageAnnotationCheck()

メソッドの詳細

getDefaultTokens

public int[] getDefaultTokens()

Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.

定義:

getDefaultTokens クラス内 Check

戻り値:

the default tokens

関連項目:

TokenTypes

getRequiredTokens

public int[] getRequiredTokens()

The tokens that this check must be registered for.

オーバーライド:

getRequiredTokens クラス内 Check

戻り値:

the token set this must be registered for.

関連項目:

TokenTypes

getAcceptableTokens

public int[] getAcceptableTokens()

The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.

オーバーライド:

getAcceptableTokens クラス内 Check

戻り値:

the token set this check is designed for.

関連項目:

TokenTypes

visitToken

public void visitToken(DetailAST aAST)

Called to process a token.

オーバーライド:

visitToken クラス内 Check

パラメータ:

aAST - the token to process