Package com.puppycrawl.tools.checkstyle.checks.imports

Record Class ModuleImportOrderCheck.ImportEntry

java.lang.Object
java.lang.Record
com.puppycrawl.tools.checkstyle.checks.imports.ModuleImportOrderCheck.ImportEntry
Record Components:
name - fully qualified name of the import
module - whether the import is a module import
ast - import AST
Enclosing class:
ModuleImportOrderCheck
private static record ModuleImportOrderCheck.ImportEntry(String name, boolean module, DetailAST ast) extends Record
Contains import attributes as import full path, module flag and import AST.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final DetailAST
    ast
    The field for the ast record component.
    private final boolean
    module
    The field for the module record component.
    private final String
    name
    The field for the name record component.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    ImportEntry(String name, boolean module, DetailAST ast)
    Creates an instance of a ImportEntry record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    DetailAST
    ast()
    Returns the value of the ast record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    (package private) int
    getEndLineNumber()
    Get import end line number from ast.
    (package private) int
    getStartLineNumber()
    Get import start line number from ast.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    module()
    Returns the value of the module record component.
    String
    name()
    Returns the value of the name record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • name

      private final String name
      The field for the name record component.

    • module

      private final boolean module
      The field for the module record component.

    • ast

      private final DetailAST ast
      The field for the ast record component.

  • Constructor Details

    • ImportEntry

      private ImportEntry(String name, boolean module, DetailAST ast)
      Creates an instance of a ImportEntry record class.
      Parameters:
      name - the value for the name record component
      module - the value for the module record component
      ast - the value for the ast record component

  • Method Details

    • getStartLineNumber

      int getStartLineNumber()
      Get import start line number from ast.
      Returns:
      import start line from ast.

    • getEndLineNumber

      int getEndLineNumber()
      Get import end line number from ast.

      Note: It can be different from startLineNumber when import statement spans multiple lines.

      Returns:
      import end line from ast.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • module

      public boolean module()
      Returns the value of the module record component.
      Returns:
      the value of the module record component

    • ast

      public DetailAST ast()
      Returns the value of the ast record component.
      Returns:
      the value of the ast record component