Checkstyle Javaルール

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

Class Design

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 クラスが拡張(サブクラス作成)用に設計されているかどうかをチェックする。 このチェックでは、オーバーライ…