Class EclipseImportOrderingStrategy

java.lang.Object
com.github.javaparser.printer.configuration.imports.EclipseImportOrderingStrategy
All Implemented Interfaces:
ImportOrderingStrategy

public class EclipseImportOrderingStrategy extends Object implements ImportOrderingStrategy
  • Field Details

    • sortImportsAlphabetically

      private boolean sortImportsAlphabetically
  • Constructor Details

    • EclipseImportOrderingStrategy

      public EclipseImportOrderingStrategy()
  • Method Details

    • sortImports

      public List<NodeList<ImportDeclaration>> sortImports(NodeList<ImportDeclaration> nodes)
      Description copied from interface: ImportOrderingStrategy
      Sort the list of imports into groups.

      Consider that we have the following list of imports as argument:

       import java.util.List;
       import com.github.javaparser.ast.NodeList;
       import com.github.javaparser.ast.ImportDeclaration;
       

      And we want the imports to look like this: (Note the spacing between imports)

       import java.util.List;
      
       import com.github.javaparser.ast.NodeList;
       import com.github.javaparser.ast.ImportDeclaration;
       

      In this case, we have two groups of imports. The first group contains only import for java.util.List, while the second group contains NodeList and ImportDeclaration.

      For this example this method should return 2 groups in the list, and the first group should have exactly 1 import, while the second group should have 2 imports.

      Specified by:
      sortImports in interface ImportOrderingStrategy
      Parameters:
      nodes - The imports to be ordered.
      Returns:
      The group of sorted imports.
    • setSortImportsAlphabetically

      public void setSortImportsAlphabetically(boolean sortAlphabetically)
      Specified by:
      setSortImportsAlphabetically in interface ImportOrderingStrategy
    • isSortImportsAlphabetically

      public boolean isSortImportsAlphabetically()
      Specified by:
      isSortImportsAlphabetically in interface ImportOrderingStrategy