Checkstyle Javaルール

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

MethodTypeParameterName

CheckStyle公式ドキュメント

検証環境

Checkstyleバージョン:10.8.0
Javaバージョン:17


チェック概要

チェック追加バージョン
Checkstyle 5.0

メソッドの型パラメータ名が指定の正規表現にマッチしているがどうかをチェックする。

プロパティ

プロパティ デフォルト値 説明 追加バージョン
format Pattern "^[A-Z]$" 型パラメータ名の正規表現 5.0

設定+チェック実行結果

プロパティ設定なし

設定ファイル記述方法

<module name="Checker">
    <module name="TreeWalker">
        <module name="MethodTypeParameterName"/>
    </module>
</module>

チェック実行例

class MyClass {
    // OK
    public <T> void method1() {
    }
    // NG 型パラメータ名の正規表現にマッチしない
    public <a> void method2() {
    }
    // OK
    public <K, V> void method3() {
    }
    // NG 型パラメータ名の正規表現にマッチしない
    public <k, V> void method4() {
    }
}

プロパティ設定あり

format

型パラメータ名の正規表現

設定ファイル記述方法

<module name="Checker">
    <module name="TreeWalker">
        <module name="MemberName">
            <property name="format" value="^[a-zA-Z]$"/>
        </module>
    </module>
</module>

チェック実行例

class MyClass {
    // OK
    public <T> void method1() {
    }
    // OK
    public <a> void method2() {
    }
    // OK
    public <K, V> void method3() {
    }
    // OK
    public <k, V> void method4() {
    }
}