Checkstyle Javaルール

CheckstyleのJavaルールについて1つずつまとめます

AtclauseOrder

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 6.0 JavadocブロックタグまたはJavadocタグの順序をチェックする。 プロパティ プロパティ 型 デフォルト値 説明 追…

FinalLocalVariable

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 値が変更されることのないローカル変数がfinalで宣言されているかどうかをチェックする。 変更されないパラメータがfinalと宣言されているかどうかもチ…

FallThrough

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 switch の case にコードが含まれているが、break、return、throw、continue文がない箇所がないかどうかをチェックする。 チェックは、警告を抑制するた…

ExplicitInitialization

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.2 クラスまたはオブジェクトのメンバが明示的にその型のデフォルト値に初期化されているかどうかをチェックする。…

EqualsHashCode

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.0 equals()またはhashCode()をオーバーライドするクラスが、もう一方もオーバーライドされていることをチェックす…

EqualsAvoidNull

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 5.0 Stringのequals()メソッド呼び出し時にnullでない値が呼び元となっていることをチェックする。 あるフィールド…

EmptyStatement

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.1 空のステートメント(単体のセミコロン「;」)を検出する。 設定+チェック実行結果 設定ファイル記述方法 <module name="Checker"> <module name="TreeWalker"> <module name="EmptyStatement"/> </module> </module></module>…

DefaultComesLast

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.4 switch文の中で default がすべてのcaseの後にあることをチェックする。 Javaではswitch文の中のどこでもdefaul…

DeclarationOrder

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.2 クラス、レコード、インタフェース宣言の各部分が、Javaプログラミング言語のコード規約で推奨される順序で表示…

CovariantEquals

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.2 共変なequals()メソッドを定義しているクラスやレコードが、equals(Object)メソッドもオーバーライドしているか…

AvoidNoArgumentSuperConstructorCall

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 8.29 引数なしのスーパークラスのコンストラクタ呼出しがあるかどうかをチェックする。 コンストラクタ本体は暗黙の…

AvoidInlineConditionals

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.1 インライン条件文を検出する。 〇 インライン条件文のサンプル String a = getParameter("a"); String b = (a =…

AvoidDoubleBraceInitialization

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 8.3 二重括弧初期化(DBI)を検出する。 DBI:最初の括弧で匿名クラスを生成し、次の括弧が初期化ブロックでオブジェ…

ArrayTrailingComma

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.2 配列の初期化時に、末尾にコンマが含まれているかどうかをチェックする。 デフォルトでは、配列の最後の要素と…

VisibilityModifier

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.0 クラスのメンバの可視性をチェックする。 static final、immutable、または指定されたアノテーションを持つメン…

ThrowsCount

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.2 throwsに指定された数以上の例外を記述していないかチェックする。 java.lang.Overrideアノテーションが付与さ…

OneTopLevelClass

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 5.8 トップレベルのクラス、インターフェース、enum、アノテーションがそれ自身のソースファイルにただ1つ存在する…

MutableException

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.2 例外クラスfinalフィールドのみを持つことをチェックする。 Exceptionインスタンスは、エラー状態を表すもので…

InterfaceIsType

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.1 メソッドを持たず定数のみを含むインタフェースを定義されていないかチェックする。 インターフェースは型を定…

InnerTypeLast

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 5.2 内部クラス/内部インターフェースがプライマリ(トップレベル)クラスの下部で宣言されていることをチェックす…

HideUtilityClassConstructor

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.1 ユーティリティクラス (staticメソッドまたはstaticフィールドのみを含むクラス) がパブリックコンストラクタを…

FinalClass

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.1 privateコンストラクタのみを持ち、子クラスを持たないクラスがfinalで宣言されているかどうかをチェックする。…

DesignForExtension

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.1 クラスが拡張(サブクラス作成)用に設計されているかどうかをチェックする。 このチェックでは、オーバーライ…

RightCurly

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.0 コードブロックの右中括弧(})の配置をチェックする。 チェック対象は以下の通り。 if-else try-catch-finally w…

NeedBraces

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.0 コードブロックの周りに中括弧があるかどうかをチェックする。 プロパティ プロパティ 型 デフォルト値 説明 追…

LeftCurly

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.0 コードブロックの左中括弧({)の配置をチェックする。 左中括弧の配置ルールの設定にはLeftCurlyOptionを指定す…

EmptyCatchBlock

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 6.4 空のcatchブロックがあるかどうかをチェックする。 デフォルトでは、catchブロック内部にコメントのみを持つcat…

EmptyBlock

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.0 空のブロックがないかチェックする。 以下のようなシーケンシャルブロックはチェック対象外となる。また、フォ…

AvoidNestedBlocks

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.1 ネストされたブロック(コード内で自由に使用されているブロック)がないかどうかをチェックする。 switch文のc…

SuppressWarningsHolder

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 5.7 SuppressWarningsアノテーションを使用して、Checkstyleのチェック抑制を許可するチェックのセットを保持する。…