Package org.technologybrewery.baton

Class AbstractMigration

java.lang.Object
org.technologybrewery.baton.AbstractMigration
All Implemented Interfaces:
Migration
public abstract class AbstractMigration extends Object implements Migration
Common migration logic to make it easier to implement custom migrations.

  • Field Details

    • name

      protected String name

    • description

      protected String description

    • active

      protected boolean active

    • fileNamePatterns

      protected Set<String> fileNamePatterns

    • backupOriginalMigratedFiles

      protected boolean backupOriginalMigratedFiles

    • backupCustomLocation

      protected String backupCustomLocation

    • numberOfBackupsToKeep

      protected int numberOfBackupsToKeep

    • project

      protected org.apache.maven.project.MavenProject project
      Enables access to the runtime properties associated with the project's POM configuration against which Baton is being executed.

  • Constructor Details

    • AbstractMigration

      public AbstractMigration()

  • Method Details

    • execute

      public MigrationSummary execute(org.apache.maven.shared.model.fileset.FileSet[] fileSets)
      If active, validates applicability of the migration each targeted file and then performs the migration. Tracks the number of files successfully and unsuccessfully changed during the process.
      Specified by:
      execute in interface Migration
      Parameters:
      fileSets - the file sets to process with this migration
      Returns:
      a summary of results

    • shouldExecuteOnFile

      protected abstract boolean shouldExecuteOnFile(File file)
      Called to determine if this migration should be run on the passed file.
      Parameters:
      file - file to check
      Returns:
      to execute or not

    • performMigration

      protected abstract boolean performMigration(File file)
      Called to perform the specific migration logic.
      Parameters:
      file - file to migrate
      Returns:
      if successful or not

    • backupOriginalFile

      protected void backupOriginalFile(File originalFile)

    • getBasedir

      protected File getBasedir()

    • getBuildDir

      protected String getBuildDir()

    • getName

      public String getName()
      Specified by:
      getName in interface Migration

    • setName

      public void setName(String name)
      Specified by:
      setName in interface Migration

    • getDescription

      public String getDescription()
      Specified by:
      getDescription in interface Migration

    • setDescription

      public void setDescription(String description)
      Specified by:
      setDescription in interface Migration

    • isActive

      public boolean isActive()
      Specified by:
      isActive in interface Migration

    • setActive

      public void setActive(boolean active)
      Specified by:
      setActive in interface Migration

    • getFileNamePatterns

      public Set<String> getFileNamePatterns()
      Specified by:
      getFileNamePatterns in interface Migration

    • setFileNamePatterns

      public void setFileNamePatterns(Set<String> fileNamePatterns)
      Specified by:
      setFileNamePatterns in interface Migration

    • shouldBackupMigratedOriginalFiles

      public boolean shouldBackupMigratedOriginalFiles()
      Specified by:
      shouldBackupMigratedOriginalFiles in interface Migration

    • setBackupMigratedOriginalFiles

      public void setBackupMigratedOriginalFiles(boolean backupOriginalMigratedFiles)
      Specified by:
      setBackupMigratedOriginalFiles in interface Migration

    • isBackupOriginalMigratedFiles

      public boolean isBackupOriginalMigratedFiles()

    • setBackupOriginalMigratedFiles

      public void setBackupOriginalMigratedFiles(boolean backupOriginalMigratedFiles)

    • getBackupCustomLocation

      public String getBackupCustomLocation()
      Specified by:
      getBackupCustomLocation in interface Migration

    • setBackupCustomLocation

      public void setBackupCustomLocation(String backupCustomLocation)
      Specified by:
      setBackupCustomLocation in interface Migration

    • getNumberOfBacksUpsToKeep

      public int getNumberOfBacksUpsToKeep()
      Specified by:
      getNumberOfBacksUpsToKeep in interface Migration

    • setNumberOfBacksUpsToKeep

      public void setNumberOfBacksUpsToKeep(int numberOfBacksUpsToKeep)
      Specified by:
      setNumberOfBacksUpsToKeep in interface Migration

    • setMavenProject

      public void setMavenProject(org.apache.maven.project.MavenProject project)
      Specified by:
      setMavenProject in interface Migration

    • getMavenProject

      public org.apache.maven.project.MavenProject getMavenProject()
      Specified by:
      getMavenProject in interface Migration