org.codehaus.mojo.versions.recording

Class ChangeRecorderXML

java.lang.Object

org.codehaus.mojo.versions.recording.ChangeRecorderXML

All Implemented Interfaces:

ChangeRecorder

public class ChangeRecorderXML
extends Object
implements ChangeRecorder

A recorder of version updates.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHANGES_NAMESPACE The XML namespace used for serialized changes.

Method Summary

Modifier and Type	Method and Description
static ChangeRecorder	create() Create a new change recorder that serializes to XML.
void	recordUpdate(String kind, String groupId, String artifactId, String oldVersion, String newVersion) Record that a dependency was updated.
void	serialize(OutputStream outputStream) Serialize the current set of changes to the given output stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CHANGES_NAMESPACE

public static final String CHANGES_NAMESPACE

The XML namespace used for serialized changes.

See Also:

Constant Field Values

Method Detail

create

public static ChangeRecorder create()

Create a new change recorder that serializes to XML.

Returns:

A new change recorder

recordUpdate

public final void recordUpdate(String kind,
                               String groupId,
                               String artifactId,
                               String oldVersion,
                               String newVersion)

Description copied from interface: ChangeRecorder

Record that a dependency was updated.

Specified by:

recordUpdate in interface ChangeRecorder

Parameters:

kind - The kind of version change

groupId - The dependency group ID

artifactId - The dependency artifact ID

oldVersion - The old version of the dependency

newVersion - The new version of the dependency

serialize

public final void serialize(OutputStream outputStream)
                     throws IOException

Description copied from interface: ChangeRecorder

Serialize the current set of changes to the given output stream.

Specified by:

serialize in interface ChangeRecorder

Parameters:

outputStream - The output stream

Throws:

IOException - On serialization and/or I/O errors