Checkstyle Javaルール

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

InterfaceTypeParameterName

CheckStyle公式ドキュメント

検証環境

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


チェック概要

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

インターフェイス型のパラメータ名が、指定された正規表現に適合しているかどうかをチェックする。

プロパティ

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

設定+チェック実行結果

プロパティ設定なし

設定ファイル記述方法

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

チェック実行例

// OK
interface FirstInterface<T> {}
// NG 型パラメータ名の正規表現にマッチしない
interface SecondInterface<t> {}

プロパティ設定あり

format

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

設定ファイル記述方法

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

チェック実行例

// OK
interface FirstInterface<T> {}
// OK
interface SecondInterface<t> {}
// NG 型パラメータ名の正規表現にマッチしない
interface ThirdInterface<type> {}