Checkstyle Javaルール

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

RecordComponentName

CheckStyle公式ドキュメント

検証環境

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


チェック概要

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

レコードコンポーネント名が指定の正規表現にマッチしているがどうかをチェックする。

プロパティ

プロパティ デフォルト値 説明 追加バージョン
format Pattern "^[a-z][a-zA-Z0-9]*$" レコードコンポーネント名の正規表現 8.40

設定+チェック実行結果

プロパティ設定なし

設定ファイル記述方法

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

チェック実行例

// OK
record MyRecord1(String value, int otherComponentName) {}
// NG レコードコンポーネント名の正規表現にマッチしない
record MyRecord2(String... Values) {}
// NG レコードコンポーネント名の正規表現にマッチしない
record MyRecord3(double my_number) {}

プロパティ設定あり

format

レコードコンポーネント名の正規表現

設定ファイル記述方法

<module name="Checker">
    <module name="TreeWalker">
        <module name="RecordComponentName">
            <property name="format" value="^[a-z]+$"/>
        </module>
    </module>
</module>

チェック実行例

// OK
record MyRecord1(String value, int other) {}
// OK
record MyRecord2(String... strings) {}
// NG レコードコンポーネント名の正規表現にマッチしない
record MyRecord3(double myNumber) {}