Package org.eolang.lints

Interface Lint<T>

Type Parameters:
T - The type of entity to analyze
All Known Implementing Classes:
AsciiOnly, UnitTestIsNotVerb, UnitTestMissing
public interface Lint<T>
A single checker for an .xmir file.
Since:
0.0.1

  • Method Summary

    Modifier and Type
    Method
    Description
    Collection<Defect>
    defects(T entity)
    Find and return defects.
    String
    motive()
    Returns motive for a lint, explaining why this lint exists.

  • Method Details

    • defects

      Collection<Defect> defects(T entity) throws IOException
      Find and return defects.
      Parameters:
      entity - The entity to analyze (could be XML or Path)
      Returns:
      Defects
      Throws:
      IOException

    • motive

      String motive() throws Exception
      Returns motive for a lint, explaining why this lint exists.
      Returns:
      Motive text about lint
      Throws:
      Exception - if something went wrong