sortpom.parameter.PluginParameters Maven / Gradle / Ivy

Go to download
package sortpom.parameter;

import java.io.File;

/** Contains all parameters that are sent to the plugin */
public class PluginParameters {
  public final File pomFile;
  public final boolean createBackupFile;
  public final String backupFileExtension;
  public final String violationFilename;
  public final String encoding;
  public final LineSeparatorUtil lineSeparatorUtil;
  public final String indentCharacters;
  public final boolean expandEmptyElements;
  public final boolean spaceBeforeCloseEmptyElement;
  public final String predefinedSortOrder;
  public final String customSortOrderFile;
  public final DependencySortOrder sortDependencies;
  public final DependencySortOrder sortDependencyExclusions;
  public final DependencySortOrder sortDependencyManagement;
  public final DependencySortOrder sortPlugins;
  public final boolean sortProperties;
  public final boolean sortModules;
  public final boolean sortExecutions;
  public final boolean keepBlankLines;
  public final boolean endWithNewline;
  public final boolean indentBlankLines;
  public final boolean indentSchemaLocation;
  public final IndentAttribute indentAttribute;
  public final VerifyFailType verifyFailType;
  public final VerifyFailOnType verifyFailOn;
  public final boolean ignoreLineSeparators;
  public final boolean keepTimestamp;

  private PluginParameters(
      File pomFile,
      boolean createBackupFile,
      String backupFileExtension,
      String violationFilename,
      String encoding,
      LineSeparatorUtil lineSeparatorUtil,
      boolean expandEmptyElements,
      boolean spaceBeforeCloseEmptyElement,
      boolean keepBlankLines,
      boolean endWithNewline,
      String indentCharacters,
      boolean indentBlankLines,
      boolean indentSchemaLocation,
      IndentAttribute indentAttribute,
      String predefinedSortOrder,
      String customSortOrderFile,
      DependencySortOrder sortDependencies,
      DependencySortOrder sortDependencyExclusions,
      DependencySortOrder sortDependencyManagement,
      DependencySortOrder sortPlugins,
      boolean sortProperties,
      boolean sortModules,
      boolean sortExecutions,
      VerifyFailType verifyFailType,
      VerifyFailOnType verifyFailOn,
      boolean ignoreLineSeparators,
      boolean keepTimestamp) {
    this.pomFile = pomFile;
    this.createBackupFile = createBackupFile;
    this.backupFileExtension = backupFileExtension;
    this.violationFilename = violationFilename;
    this.encoding = encoding;
    this.lineSeparatorUtil = lineSeparatorUtil;
    this.indentCharacters = indentCharacters;
    this.expandEmptyElements = expandEmptyElements;
    this.spaceBeforeCloseEmptyElement = spaceBeforeCloseEmptyElement;
    this.predefinedSortOrder = predefinedSortOrder;
    this.customSortOrderFile = customSortOrderFile;
    this.sortDependencies = sortDependencies;
    this.sortDependencyExclusions = sortDependencyExclusions;
    this.sortDependencyManagement = sortDependencyManagement;
    this.sortPlugins = sortPlugins;
    this.sortProperties = sortProperties;
    this.sortModules = sortModules;
    this.sortExecutions = sortExecutions;
    this.keepBlankLines = keepBlankLines;
    this.endWithNewline = endWithNewline;
    this.indentBlankLines = indentBlankLines;
    this.indentSchemaLocation = indentSchemaLocation;
    this.indentAttribute = indentAttribute;
    this.verifyFailType = verifyFailType;
    this.verifyFailOn = verifyFailOn;
    this.ignoreLineSeparators = ignoreLineSeparators;
    this.keepTimestamp = keepTimestamp;
  }

  /** Instantiate builder */
  public static Builder builder() {
    return new PluginParameters.Builder();
  }

  /** Builder for the PluginParameters class */
  public static class Builder {
    private File pomFile;
    private boolean createBackupFile;
    private String backupFileExtension;
    private String violationFilename;
    private String encoding;
    private LineSeparatorUtil lineSeparatorUtil;
    private String indentCharacters;
    private boolean indentBlankLines;
    private boolean indentSchemaLocation;
    private IndentAttribute indentAttribute = IndentAttribute.NONE;
    private boolean expandEmptyElements;
    private boolean spaceBeforeCloseEmptyElement;
    private String predefinedSortOrder;
    private String customSortOrderFile;
    private DependencySortOrder sortDependencies;
    private DependencySortOrder sortDependencyExclusions;
    private DependencySortOrder sortDependencyManagement;
    private DependencySortOrder sortPlugins;
    private boolean sortProperties;
    private boolean sortModules;
    private boolean sortExecutions;
    private boolean keepBlankLines;
    private boolean endWithNewline;
    private VerifyFailType verifyFailType;
    private VerifyFailOnType verifyFailOn;
    private boolean ignoreLineSeparators;
    private boolean keepTimestamp;

    private Builder() {}

    /** Sets pomFile location */
    public Builder setPomFile(File pomFile) {
      this.pomFile = pomFile;
      return this;
    }

    /** Sets information regarding backup file */
    public Builder setFileOutput(
        final boolean createBackupFile,
        final String backupFileExtension,
        String violationFilename,
        boolean keepTimestamp) {
      this.createBackupFile = createBackupFile;
      this.backupFileExtension = backupFileExtension;
      this.violationFilename = violationFilename;
      this.keepTimestamp = keepTimestamp;
      return this;
    }

    /** Sets which encoding should be used throughout the plugin */
    public Builder setEncoding(String encoding) {
      this.encoding = encoding;
      return this;
    }

    /** Sets formatting information that is used when the pom file is sorted */
    public Builder setFormatting(
        final String lineSeparator,
        final boolean expandEmptyElements,
        final boolean spaceBeforeCloseEmptyElement,
        final boolean keepBlankLines,
        final boolean endWithNewline) {
      this.lineSeparatorUtil = new LineSeparatorUtil(lineSeparator);
      this.expandEmptyElements = expandEmptyElements;
      this.spaceBeforeCloseEmptyElement = spaceBeforeCloseEmptyElement;
      this.keepBlankLines = keepBlankLines;
      this.endWithNewline = endWithNewline;
      return this;
    }

    /** Sets indent information that is used when the pom file is sorted */
    public Builder setIndent(
        final int nrOfIndentSpace,
        final boolean indentBlankLines,
        boolean indentSchemaLocation,
        String indentAttribute) {
      this.indentCharacters = new IndentCharacters(nrOfIndentSpace).getIndentCharacters();
      this.indentBlankLines = indentBlankLines;
      this.indentSchemaLocation = indentSchemaLocation;
      this.indentAttribute =
          indentAttribute == null && indentSchemaLocation
              ? IndentAttribute.SCHEMA_LOCATION
              : IndentAttribute.fromString(indentAttribute);
      return this;
    }

    /** Sets which sort order that should be used when sorting */
    public Builder setSortOrder(
        final String customSortOrderFile, final String predefinedSortOrder) {
      this.customSortOrderFile = customSortOrderFile;
      this.predefinedSortOrder = predefinedSortOrder;
      return this;
    }

    /** Sets if any additional pom file elements should be sorted */
    public Builder setSortEntities(
        final String sortDependencies,
        final String sortDependencyExclusions,
        final String sortDependencyManagement,
        final String sortPlugins,
        final boolean sortProperties,
        final boolean sortModules,
        boolean sortExecutions) {
      this.sortDependencies = new DependencySortOrder(sortDependencies);
      this.sortDependencyExclusions = new DependencySortOrder(sortDependencyExclusions);
      this.sortDependencyManagement = new DependencySortOrder(sortDependencyManagement);
      this.sortPlugins = new DependencySortOrder(sortPlugins);
      this.sortProperties = sortProperties;
      this.sortModules = sortModules;
      this.sortExecutions = sortExecutions;
      return this;
    }

    /** Sets the verify operation behaviour */
    public Builder setVerifyFail(String verifyFail, String verifyFailOn) {
      this.verifyFailType = VerifyFailType.fromString(verifyFail);
      this.verifyFailOn = VerifyFailOnType.fromString(verifyFailOn);
      return this;
    }

    /** Sets if line separators should be considered when the pom should be sorted * */
    public Builder setIgnoreLineSeparators(boolean ignoreLineSeparators) {
      this.ignoreLineSeparators = ignoreLineSeparators;
      return this;
    }

    /** Build the PluginParameters instance */
    public PluginParameters build() {
      return new PluginParameters(
          pomFile,
          createBackupFile,
          backupFileExtension,
          violationFilename,
          encoding,
          lineSeparatorUtil,
          expandEmptyElements,
          spaceBeforeCloseEmptyElement,
          keepBlankLines,
          endWithNewline,
          indentCharacters,
          indentBlankLines,
          indentSchemaLocation,
          indentAttribute,
          predefinedSortOrder,
          customSortOrderFile,
          sortDependencies,
          sortDependencyExclusions,
          sortDependencyManagement,
          sortPlugins,
          sortProperties,
          sortModules,
          sortExecutions,
          verifyFailType,
          verifyFailOn,
          ignoreLineSeparators,
          keepTimestamp);
    }
  }
}