Interface CheckstyleResult

All Superinterfaces:
FaultAware, Resource
All Known Implementing Classes:
DefaultCheckstyleResult

public interface CheckstyleResult extends Resource, FaultAware
Provides the results from running checkstyle.
  • Method Details

    • project

      The project that was checked.
      Returns:
      the project
    • checked

      long checked()
      Returns the number of checked files.
      Returns:
      the number
    • errors

      long errors()
      Returns the number of style violations with error severity.
      Returns:
      the number
    • warnings

      long warnings()
      Returns the number of style violations with warning severity.
      Returns:
      the number
    • of

      static CheckstyleResult of(Project project, ResourceProvider provider, long checked, long errors, long warnings)
      Creates a new checkstyle result from the given values.
      Parameters:
      project - the project
      provider - the provider
      checked - the number of checked files
      errors - the number of style violations with error severity
      warnings - the number of style violations with warning severity
      Returns:
      the checkstyle result