org.codehaus.mojo.versions.api.recording

Interface ChangeRecorder

public interface ChangeRecorder

Interface for implement a recorder of version changes.

Since:

2.14.0

Author:

Slawomir Jaranowski

Method Summary

Modifier and Type	Method and Description
void	recordChange(DependencyChangeRecord changeRecord) Record that a dependency was updated.
void	recordChange(PropertyChangeRecord changeRecord) Record that a property was updated.
void	writeReport(Path outputPath) Write the current set of changes to the given output path.

Method Detail

recordChange

void recordChange(DependencyChangeRecord changeRecord)

Record that a dependency was updated.

Parameters:

changeRecord - a dependency record described change

Since:

2.14.0

recordChange

void recordChange(PropertyChangeRecord changeRecord)

Record that a property was updated.

Parameters:

changeRecord - a property record described change

Since:

2.14.0

writeReport

void writeReport(Path outputPath)
          throws IOException

Write the current set of changes to the given output path.

Implementation is responsible for creating all missing directories.

Output should not be created for empty record sets.

Parameters:

outputPath - The output path, can be null, provided by changeRecorderOutputFile plugin parameters

Throws:

IOException - On write and/or I/O errors

Since:

2.14.0