Index

A B C D E F G H I L M N O P R S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractMigration - Class in org.technologybrewery.baton

Common migration logic to make it easier to implement custom migrations.

AbstractMigration() - Constructor for class org.technologybrewery.baton.AbstractMigration

active - Variable in class org.technologybrewery.baton.AbstractMigration

addExclude(String) - Method in class org.technologybrewery.baton.config.FileSet

addFileSets(FileSet) - Method in class org.technologybrewery.baton.config.MigrationTarget

addGroupSummary(GroupSummary) - Method in class org.technologybrewery.baton.BatonExecutionSummary

Adds a specific migration summary run to the cross-migration summary..

addInclude(String) - Method in class org.technologybrewery.baton.config.FileSet

addMigration(MigrationTarget) - Method in class org.technologybrewery.baton.config.GroupTarget

addMigrationSummary(MigrationSummary) - Method in class org.technologybrewery.baton.GroupSummary

Adds a migration summary to the group summary

appliesTo(int) - Method in class org.technologybrewery.baton.util.pom.PomModifications.Final

apply(BufferedReader, Writer, String) - Method in class org.technologybrewery.baton.util.pom.PomModifications.Deletion

apply(BufferedReader, Writer, String) - Method in class org.technologybrewery.baton.util.pom.PomModifications.Final

Applies the next modification to the input reader, writing the result to the output writer.

apply(BufferedReader, Writer, String) - Method in class org.technologybrewery.baton.util.pom.PomModifications.Insertion

apply(BufferedReader, Writer, String) - Method in class org.technologybrewery.baton.util.pom.PomModifications.Modification

apply(BufferedReader, Writer, String) - Method in class org.technologybrewery.baton.util.pom.PomModifications.Replacement

B

backupCustomLocation - Variable in class org.technologybrewery.baton.AbstractMigration

backupCustomLocation - Variable in class org.technologybrewery.baton.BatonMojo

Customizes the location where backup of original files prior to migration is performed.

backupOriginalFile(File) - Method in class org.technologybrewery.baton.AbstractMigration

backupOriginalMigratedFiles - Variable in class org.technologybrewery.baton.AbstractMigration

backupOriginalMigratedFiles - Variable in class org.technologybrewery.baton.BatonMojo

Allows backup of original files prior to migration to be turned off.

baseDirectory - Variable in class org.technologybrewery.baton.BatonMojo

Base directory in which to operate.

BatonException - Exception in org.technologybrewery.baton

Baton-specific exception.

BatonException() - Constructor for exception org.technologybrewery.baton.BatonException

BatonException(String) - Constructor for exception org.technologybrewery.baton.BatonException

BatonException(String, Throwable) - Constructor for exception org.technologybrewery.baton.BatonException

BatonException(Throwable) - Constructor for exception org.technologybrewery.baton.BatonException

BatonExecutionSummary - Class in org.technologybrewery.baton

Provides summary information across multiple baton migration executions.

BatonExecutionSummary() - Constructor for class org.technologybrewery.baton.BatonExecutionSummary

BatonMojo - Class in org.technologybrewery.baton

A Maven plugin that allows migration logic to be executed against a Maven module based on a classpath-provided migrations.

BatonMojo() - Constructor for class org.technologybrewery.baton.BatonMojo

C

CommonUtils - Class in org.technologybrewery.baton.util

Common logic used when performing a migration.

compareTo(PomModifications.Modification) - Method in class org.technologybrewery.baton.util.pom.PomModifications.Modification

contentTransformer - Variable in class org.technologybrewery.baton.util.pom.LocationAwareMavenReader

Field contentTransformer.

D

deactivateMigrations - Variable in class org.technologybrewery.baton.BatonMojo

Allows a list of migration names that should be deactivated.

defaultFileSets() - Method in class org.technologybrewery.baton.BatonMojo

Deletion(InputLocation, InputLocation) - Constructor for class org.technologybrewery.baton.util.pom.PomModifications.Deletion

Constructor to delete content between the given start and end parameters.

description - Variable in class org.technologybrewery.baton.AbstractMigration

E

END - Static variable in class org.technologybrewery.baton.util.pom.LocationAwareMavenReader

equals(Object) - Method in class org.technologybrewery.baton.util.pom.PomModifications.Deletion

equals(Object) - Method in class org.technologybrewery.baton.util.pom.PomModifications.Insertion

equals(Object) - Method in class org.technologybrewery.baton.util.pom.PomModifications.Modification

equals(Object) - Method in class org.technologybrewery.baton.util.pom.PomModifications.Replacement

execute() - Method in class org.technologybrewery.baton.BatonMojo

execute(FileSet[]) - Method in class org.technologybrewery.baton.AbstractMigration

If active, validates applicability of the migration each targeted file and then performs the migration.

execute(FileSet[]) - Method in interface org.technologybrewery.baton.Migration

Executes the migration.

F

fileNamePatterns - Variable in class org.technologybrewery.baton.AbstractMigration

FileSet - Class in org.technologybrewery.baton.config

Json repesentation of the files to proceess with Baton.

FileSet() - Constructor for class org.technologybrewery.baton.config.FileSet

fileSets - Variable in class org.technologybrewery.baton.BatonMojo

A list of fileSet rules to select files and directories.

FileUtils - Class in org.technologybrewery.baton.util

Common file-related logic used when performing a migration.

finalizeMods() - Method in class org.technologybrewery.baton.util.pom.PomModifications

Returns an instance of the Final class configure with an iterable of all loaded POM file modifications.

G

getAddDefaultEntities() - Method in class org.technologybrewery.baton.util.pom.LocationAwareMavenReader

Returns the state of the "add default entities" flag.

getBackupCustomLocation() - Method in class org.technologybrewery.baton.AbstractMigration

getBackupCustomLocation() - Method in interface org.technologybrewery.baton.Migration

getBasedir() - Method in class org.technologybrewery.baton.AbstractMigration

getBuildDir() - Method in class org.technologybrewery.baton.AbstractMigration

getContentProducer() - Method in class org.technologybrewery.baton.util.pom.PomModifications.Replacement

getDescription() - Method in class org.technologybrewery.baton.AbstractMigration

getDescription() - Method in class org.technologybrewery.baton.config.MigrationTarget

getDescription() - Method in interface org.technologybrewery.baton.Migration

getDirectory() - Method in class org.technologybrewery.baton.config.FileSet

getEnd() - Method in class org.technologybrewery.baton.util.pom.PomModifications.Deletion

getEnd() - Method in class org.technologybrewery.baton.util.pom.PomModifications.Replacement

getExcludes() - Method in class org.technologybrewery.baton.config.FileSet

getFileNamePatterns() - Method in class org.technologybrewery.baton.AbstractMigration

getFileNamePatterns() - Method in interface org.technologybrewery.baton.Migration

getFileSets() - Method in class org.technologybrewery.baton.config.MigrationTarget

getFileSetsForTarget(MigrationTarget) - Method in class org.technologybrewery.baton.BatonMojo

getFilesSuccessfullyMigrated() - Method in class org.technologybrewery.baton.MigrationSummary

getFilesUnsuccessfullyMigrated() - Method in class org.technologybrewery.baton.MigrationSummary

getFollowSymlinks() - Method in class org.technologybrewery.baton.config.FileSet

getGroup() - Method in class org.technologybrewery.baton.config.GroupTarget

getGroupName() - Method in class org.technologybrewery.baton.GroupSummary

getGroupSummaries() - Method in class org.technologybrewery.baton.BatonExecutionSummary

getImplementation() - Method in class org.technologybrewery.baton.config.MigrationTarget

getIncludes() - Method in class org.technologybrewery.baton.config.FileSet

getIndent(String, int) - Static method in class org.technologybrewery.baton.util.FileUtils

Infers the indentation style from the given line.

getIndentLvl() - Method in class org.technologybrewery.baton.util.pom.PomModifications.Replacement

getLocationAnnotatedModel(File) - Static method in class org.technologybrewery.baton.util.pom.PomHelper

Helper function to construct a Model of a pom file.

getMavenProject() - Method in class org.technologybrewery.baton.AbstractMigration

getMavenProject() - Method in interface org.technologybrewery.baton.Migration

getMigrations() - Method in class org.technologybrewery.baton.config.GroupTarget

getMigrationSummaries() - Method in class org.technologybrewery.baton.GroupSummary

getName() - Method in class org.technologybrewery.baton.AbstractMigration

getName() - Method in class org.technologybrewery.baton.config.MigrationTarget

getName() - Method in interface org.technologybrewery.baton.Migration

getName() - Method in class org.technologybrewery.baton.MigrationSummary

getNumberOfBacksUpsToKeep() - Method in class org.technologybrewery.baton.AbstractMigration

getNumberOfBacksUpsToKeep() - Method in interface org.technologybrewery.baton.Migration

getNumberOfTargetsExecuted() - Method in class org.technologybrewery.baton.BatonExecutionSummary

getRegExCaptureGroups(String, File) - Static method in class org.technologybrewery.baton.util.FileUtils

Retrieves capture groups from a regular expression match inside a file.

getRegExCaptureGroups(String, String) - Static method in class org.technologybrewery.baton.util.FileUtils

Retrieves capture groups from a regular expression match inside a String.

getSchemaFileName() - Method in class org.technologybrewery.baton.config.GroupTarget

getStart() - Method in class org.technologybrewery.baton.util.pom.PomModifications.Modification

getSummary() - Method in class org.technologybrewery.baton.BatonExecutionSummary

Human-readable summary information.

getType() - Method in class org.technologybrewery.baton.config.GroupTarget

getVersion() - Method in class org.technologybrewery.baton.config.MigrationTarget

GroupSummary - Class in org.technologybrewery.baton

High level summarization information for a specific Group.

GroupSummary(String) - Constructor for class org.technologybrewery.baton.GroupSummary

GroupTarget - Class in org.technologybrewery.baton.config

Holds target information to support group execution.

GroupTarget() - Constructor for class org.technologybrewery.baton.config.GroupTarget

H

hasRegExMatch(String, File) - Static method in class org.technologybrewery.baton.util.FileUtils

Evaluates a regex pattern against a file to determine if at least one regex match exists

I

incrementColumn(InputLocation, int) - Static method in class org.technologybrewery.baton.util.pom.PomHelper

Shifts the given column index for a given InputLocation type by a given amount.

indentValues(List<String>, int) - Static method in class org.technologybrewery.baton.util.FileUtils

Indent the values the desired number of tabs with a variable tab size.

initializeObjectMapper() - Method in class org.technologybrewery.baton.BatonMojo

Insertion(InputLocation, int, UnaryOperator<String>) - Constructor for class org.technologybrewery.baton.util.pom.PomModifications.Insertion

Constructor to insert content before the given start existing content on the given start index.

isActive() - Method in class org.technologybrewery.baton.AbstractMigration

isActive() - Method in interface org.technologybrewery.baton.Migration

isActive(MigrationTarget) - Method in class org.technologybrewery.baton.BatonMojo

isBackupOriginalMigratedFiles() - Method in class org.technologybrewery.baton.AbstractMigration

isLessThanVersion(String, String) - Static method in class org.technologybrewery.baton.util.CommonUtils

Checks if version1 is less than version2 using the Semver4j library.

isMinimumVersion(MigrationTarget, String) - Method in class org.technologybrewery.baton.BatonMojo

L

loadMigrations() - Method in class org.technologybrewery.baton.BatonMojo

Scans the classpath for any migrations.json files and loads all defined MigrationTarget configurations.

LocationAwareMavenReader - Class in org.technologybrewery.baton.util.pom

This class is nearly an exact copy of MavenXpp3ReaderEx (which tracks the location of model elements in the original source POM).

LocationAwareMavenReader() - Constructor for class org.technologybrewery.baton.util.pom.LocationAwareMavenReader

LocationAwareMavenReader(LocationAwareMavenReader.ContentTransformer) - Constructor for class org.technologybrewery.baton.util.pom.LocationAwareMavenReader

LocationAwareMavenReader.ContentTransformer - Interface in org.technologybrewery.baton.util.pom

M

Migration - Interface in org.technologybrewery.baton

Interface to authoring a migration.

migrationsFileName - Variable in class org.technologybrewery.baton.BatonMojo

The configurations file name to look for in the classpath (all matches will be used).

MigrationSummary - Class in org.technologybrewery.baton

High level summarization information for a specific Migration run.

MigrationSummary(String, int, int) - Constructor for class org.technologybrewery.baton.MigrationSummary

MigrationTarget - Class in org.technologybrewery.baton.config

Holds target information to support migration execution.

MigrationTarget() - Constructor for class org.technologybrewery.baton.config.MigrationTarget

minimumVersion - Variable in class org.technologybrewery.baton.BatonMojo

Used to filter out migrations that are less than the value

Modification(InputLocation) - Constructor for class org.technologybrewery.baton.util.pom.PomModifications.Modification

The constructor accepts an InputLocation type representing the line and column of the file where modifications will start being applied.

modifyRegexMatchInFile(File, String, String, String) - Static method in class org.technologybrewery.baton.util.FileUtils

Evaluates a file against a regex pattern and replaces a substring of each regex match with a specified replacement.

N

name - Variable in class org.technologybrewery.baton.AbstractMigration

numberOfBackupsToKeep - Variable in class org.technologybrewery.baton.AbstractMigration

numberOfBackupsToKeep - Variable in class org.technologybrewery.baton.BatonMojo

Allows the number of backups for original files prior to migration to be customized.

O

ORDERED - Static variable in class org.technologybrewery.baton.BatonMojo

org.technologybrewery.baton - package org.technologybrewery.baton

org.technologybrewery.baton.config - package org.technologybrewery.baton.config

org.technologybrewery.baton.util - package org.technologybrewery.baton.util

org.technologybrewery.baton.util.pom - package org.technologybrewery.baton.util.pom

P

performMigration(File) - Method in class org.technologybrewery.baton.AbstractMigration

Called to perform the specific migration logic.

PomHelper - Class in org.technologybrewery.baton.util.pom

Generalized static utilities for assisting with altering Maven POM files.

PomModifications - Class in org.technologybrewery.baton.util.pom

Tracks and applies modifications to a Maven POM file "in-place" to preserve formatting.

PomModifications() - Constructor for class org.technologybrewery.baton.util.pom.PomModifications

PomModifications.Deletion - Class in org.technologybrewery.baton.util.pom

Advances the input reader to the line at the specified end location, writing only the content that is not between the start location and the end location to the output writer.

PomModifications.Final - Class in org.technologybrewery.baton.util.pom

A class to iteratively apply a series of POM file modifications.

PomModifications.Insertion - Class in org.technologybrewery.baton.util.pom

Inserts the produced content at the specified start line and before the existing content on that line.

PomModifications.Modification - Class in org.technologybrewery.baton.util.pom

The abstract class by which all POM file modifications inherit from.

PomModifications.Replacement - Class in org.technologybrewery.baton.util.pom

Replaces the content between the start and end locations with the produced content.

project - Variable in class org.technologybrewery.baton.AbstractMigration

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

project - Variable in class org.technologybrewery.baton.BatonMojo

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

R

read(InputStream, boolean, InputSource) - Method in class org.technologybrewery.baton.util.pom.LocationAwareMavenReader

Method read.

read(Reader, boolean, InputSource) - Method in class org.technologybrewery.baton.util.pom.LocationAwareMavenReader

readAllFileLines(File) - Static method in class org.technologybrewery.baton.util.FileUtils

Reads in the File object and returns a List of the contents.

replaceInFile(File, String, String) - Static method in class org.technologybrewery.baton.util.FileUtils

Evaluates a file against a regex pattern and replaces the captured string(s) of each regex match with a specified replacement

replaceLiteralInFile(File, String, String) - Static method in class org.technologybrewery.baton.util.FileUtils

Evaluates a file against a literal string and replaces each match with a specified replacement.

Replacement(InputLocation, InputLocation, int, UnaryOperator<String>) - Constructor for class org.technologybrewery.baton.util.pom.PomModifications.Replacement

Constructor for multi-line replacements.

Replacement(InputLocation, InputLocation, String) - Constructor for class org.technologybrewery.baton.util.pom.PomModifications.Replacement

Constructor for replacing content within a single line.

S

setActive(boolean) - Method in class org.technologybrewery.baton.AbstractMigration

setActive(boolean) - Method in interface org.technologybrewery.baton.Migration

setAddDefaultEntities(boolean) - Method in class org.technologybrewery.baton.util.pom.LocationAwareMavenReader

Sets the state of the "add default entities" flag.

setBackupCustomLocation(String) - Method in class org.technologybrewery.baton.AbstractMigration

setBackupCustomLocation(String) - Method in interface org.technologybrewery.baton.Migration

setBackupMigratedOriginalFiles(boolean) - Method in class org.technologybrewery.baton.AbstractMigration

setBackupMigratedOriginalFiles(boolean) - Method in interface org.technologybrewery.baton.Migration

setBackupOriginalMigratedFiles(boolean) - Method in class org.technologybrewery.baton.AbstractMigration

setDescription(String) - Method in class org.technologybrewery.baton.AbstractMigration

setDescription(String) - Method in class org.technologybrewery.baton.config.MigrationTarget

setDescription(String) - Method in interface org.technologybrewery.baton.Migration

setDirectory(String) - Method in class org.technologybrewery.baton.config.FileSet

setExcludes(List<String>) - Method in class org.technologybrewery.baton.config.FileSet

setFileNamePatterns(Set<String>) - Method in class org.technologybrewery.baton.AbstractMigration

setFileNamePatterns(Set<String>) - Method in interface org.technologybrewery.baton.Migration

setFollowSymlinks(Boolean) - Method in class org.technologybrewery.baton.config.FileSet

setGroup(String) - Method in class org.technologybrewery.baton.config.GroupTarget

setImplementation(String) - Method in class org.technologybrewery.baton.config.MigrationTarget

setIncludes(List<String>) - Method in class org.technologybrewery.baton.config.FileSet

setMavenProject(MavenProject) - Method in class org.technologybrewery.baton.AbstractMigration

setMavenProject(MavenProject) - Method in interface org.technologybrewery.baton.Migration

setName(String) - Method in class org.technologybrewery.baton.AbstractMigration

setName(String) - Method in class org.technologybrewery.baton.config.MigrationTarget

setName(String) - Method in interface org.technologybrewery.baton.Migration

setNumberOfBacksUpsToKeep(int) - Method in class org.technologybrewery.baton.AbstractMigration

setNumberOfBacksUpsToKeep(int) - Method in interface org.technologybrewery.baton.Migration

setType(String) - Method in class org.technologybrewery.baton.config.GroupTarget

setVersion(String) - Method in class org.technologybrewery.baton.config.MigrationTarget

shouldBackupMigratedOriginalFiles() - Method in class org.technologybrewery.baton.AbstractMigration

shouldBackupMigratedOriginalFiles() - Method in interface org.technologybrewery.baton.Migration

shouldExecuteOnFile(File) - Method in class org.technologybrewery.baton.AbstractMigration

Called to determine if this migration should be run on the passed file.

sortMigrationsInGroups(List<GroupTarget>) - Method in class org.technologybrewery.baton.BatonMojo

sourceDirectory - Variable in class org.technologybrewery.baton.BatonMojo

Folder in which source files are located.

START - Static variable in class org.technologybrewery.baton.util.pom.LocationAwareMavenReader

T

testDirectory - Variable in class org.technologybrewery.baton.BatonMojo

Folder in which test files are located, if not already covered by sourceDirectory (e.g., with typical python project standards).

transform(String, String) - Method in interface org.technologybrewery.baton.util.pom.LocationAwareMavenReader.ContentTransformer

Interpolate the value read from the xpp3 document

V

VERSIONED - Static variable in class org.technologybrewery.baton.BatonMojo

W

writeFile(File, List<String>) - Static method in class org.technologybrewery.baton.util.FileUtils

Writes a List of the contents to the File object.

writeModifications(File, PomModifications.Final) - Static method in class org.technologybrewery.baton.util.pom.PomHelper

Writes a finalized set of modifications back to a pom file.

A B C D E F G H I L M N O P R S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form