Checkstyle / Module / Imports

• Prev
• Next
• Checkstyle

import文のチェック。

AvoidStarImport

ワイルドカードを使ったimport文がないことをチェックします。

記述サンプル

• Standard Checkstyle

  <module name = "AvoidStarImport" />

• Plug-in Checkstyle

  <rule-configuration
      classname = "com.puppycrawl.tools.checkstyle.checks.AvoidStarImportCheck"
      severity = "warning">
      <config-properties />
  </rule-configuration>

IllegalImport

不正なパッケージからのインポートをチェックします。不正なパッケージは、プロパティで指定。

記述サンプル

• Standard Checkstyle

  <module name = "IllegalImport">
      <property name = "illegalPkgs" value = "java.io, java.text" />
  </module>

• Plug-in Checkstyle

  <rule-configuration
      classname = "com.puppycrawl.tools.checkstyle.checks.IllegalImportCheck"
      severity = "warning">
      <config-properties>
          <config-property name = "illegalPkgs" value = "java.io, java.text" />
      </config-properties>
  </rule-configuration>

RedundantImport

冗長なインポートのチェックをします。

• インポート文が重複して、存在している。
• 暗黙的に利用できるjava.langパッケージのクラスを、明示的にインポートしている。
• 同一パッケージのクラスをインポートしている。

記述サンプル

• Standard Checkstyle

  <module name = "RedundantImport" />

• Plug-in Checkstyle

  <rule-configuration
      classname = "com.puppycrawl.tools.checkstyle.checks.RedundantImportCheck"
      severity = "warning">
      <config-properties />
  </rule-configuration>

UnusedImport

使われていないクラスをインポートしているかをチェックします。

記述サンプル

• Standard Checkstyle

  <module name = "UnusedImport" />

• Plug-in Checkstyle

  <rule-configuration
      classname = "com.puppycrawl.tools.checkstyle.checks.UnusedImportCheck"
      severity = "warning">
      <config-properties />
  </rule-configuration>

ImportOrder

import 文の順番/まとめ方をチェックします。

まとめ方とは、パッケージ名がある同じ文字列で始まっているものを、同じグループであると考えることから始まります。例えば、"java" というグループを考える場合、java.lang.Boolean と java.util.Arrays は同じグループであるとなります。そして、このグループ内で、辞書順に並んでいるかをチェックすることになります。

記述サンプル

• Standard Checkstyle

  <module name = "ImportOrder">
     <property name = "groups" value = "java.util, java.io, java.text" />
     <property name = "ordered" value = "true" />
     <property name = "separated" value = "true" />
     <property name = "caseSensitive" value = "false" />
  </module>

• Prev
  Checkstyle/Module/Headers
• Next
  Checkstyle/Module/JavadocComments
• Home
  Up?