Package sonia.scm.repository.api

Class ModificationsCommandBuilder

java.lang.Object

sonia.scm.repository.api.ModificationsCommandBuilder

public final class ModificationsCommandBuilder
extends Object

Get the modifications applied to files in a revision.

Modifications are for example: Add, Update and Delete

Since:

2.0

Constructor Summary

Constructors

Constructor	Description
ModificationsCommandBuilder()

Method Summary

Modifier and Type	Method	Description
ModificationsCommandBuilder	baseRevision(String baseRevision)	Set this to compute the modifications between two revisions.
Modifications	getModifications()	Computes the modifications.
ModificationsCommandBuilder	reset()	Reset each parameter to its default value.
ModificationsCommandBuilder	revision(String revision)	Set this to compute either the midifications of the given revision, or additionally set baseRevision(String) to compute the modifications between this and the other revision.

Methods inherited from class java.lang.Object

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

Constructor Details

ModificationsCommandBuilder

public ModificationsCommandBuilder()

Method Details

revision

public ModificationsCommandBuilder revision(String revision)

Set this to compute either the midifications of the given revision, or additionally set baseRevision(String) to compute the modifications between this and the other revision.

Returns:

This command builder.

baseRevision

public ModificationsCommandBuilder baseRevision(String baseRevision)

Set this to compute the modifications between two revisions. If this is not set, only the modifications of the revision set by revision(String) will be computed. This is only supported by repositories supporting the feature Feature.MODIFICATIONS_BETWEEN_REVISIONS.

Parameters:

baseRevision - If set, the command will compute the modifications between this revision and the revision set by revision(String).

Returns:

This command builder.

Since:

2.23.0

reset

public ModificationsCommandBuilder reset()

Reset each parameter to its default value.

Returns:

this

getModifications

public Modifications getModifications()
                               throws IOException

Computes the modifications.

Throws:

IOException