Package sonia.scm.repository.api

Class ModifyCommandBuilder

java.lang.Object

sonia.scm.repository.api.ModifyCommandBuilder

public class ModifyCommandBuilder
extends Object

Use this ModifyCommandBuilder to make file changes to the head of a branch. You can

• create new files (createFile(String) (with the option to overwrite a file, if it already exists; by default a AlreadyExistsException will be thrown)
• modify existing files (modifyFile(String)
• delete existing files (deleteFile(String)

You can collect multiple changes before they are executed with a call to execute().

Example:

 commandBuilder
     .setBranch("feature/branch")
     .setCommitMessage("make some changes")
     .setAuthor(new Person())
     .createFile("file/to/create").withData(inputStream)
     .deleteFile("old/file/to/delete")
     .execute();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ModifyCommandBuilder.ContentLoader
class	ModifyCommandBuilder.MoveBuilder
class	ModifyCommandBuilder.SimpleContentLoader
class	ModifyCommandBuilder.WithOverwriteFlagContentLoader

Method Summary

Modifier and Type	Method	Description
ModifyCommandBuilder.WithOverwriteFlagContentLoader	createFile(String path)	Create a new file.
ModifyCommandBuilder	deleteFile(String path)	Delete an existing file.
ModifyCommandBuilder	deleteFile(String path, boolean recursive)
ModifyCommandBuilder	disableSigning()	Disables adding a verifiable signature to the modification commit.
String	execute()	Apply the changes and create a new commit with the given message and author.
boolean	isEmpty()
ModifyCommandBuilder.SimpleContentLoader	modifyFile(String path)	Modify an existing file.
ModifyCommandBuilder.MoveBuilder	move(String fromPath)	Move existing directories or files.
ModifyCommandBuilder	setAuthor(Person author)	Set the author for the new commit.
ModifyCommandBuilder	setBranch(String branch)	Set the branch the changes should be made upon.
ModifyCommandBuilder	setCommitMessage(String message)	Set the commit message for the new commit.
ModifyCommandBuilder	setExpectedRevision(String expectedRevision)	Set the expected revision of the branch, before the changes are applied.
ModifyCommandBuilder	useDefaultPath(boolean useDefaultPath)

Methods inherited from class java.lang.Object

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

Method Details

createFile

public ModifyCommandBuilder.WithOverwriteFlagContentLoader createFile(String path)

Create a new file. The content of the file will be specified in a subsequent call to ModifyCommandBuilder.ContentLoader.withData(ByteSource) or ModifyCommandBuilder.ContentLoader.withData(InputStream). By default, an AlreadyExistsException will be thrown, when there already exists a file with the given path. You can disable this setting ModifyCommandBuilder.WithOverwriteFlagContentLoader.setOverwrite(boolean) to true.

Parameters:

path - The path and the name of the file that should be created.

Returns:

The loader to specify the content of the new file.

modifyFile

public ModifyCommandBuilder.SimpleContentLoader modifyFile(String path)

Modify an existing file. The new content of the file will be specified in a subsequent call to ModifyCommandBuilder.ContentLoader.withData(ByteSource) or ModifyCommandBuilder.ContentLoader.withData(InputStream).

Parameters:

path - The path and the name of the file that should be modified.

Returns:

The loader to specify the new content of the file.

move

public ModifyCommandBuilder.MoveBuilder move(String fromPath)

Move existing directories or files.

Parameters:

fromPath - The source file or directory.

Returns:

A sub builder to specify the target and further options for the move.

Since:

2.28.0

deleteFile

public ModifyCommandBuilder deleteFile(String path)

Delete an existing file.

Parameters:

path - The path and the name of the file that should be deleted.

Returns:

This builder instance.

deleteFile

public ModifyCommandBuilder deleteFile(String path,
 boolean recursive)

execute

public String execute()

Apply the changes and create a new commit with the given message and author.

Returns:

The revision of the new commit.

isEmpty

public boolean isEmpty()

setCommitMessage

public ModifyCommandBuilder setCommitMessage(String message)

Set the commit message for the new commit.

Returns:

This builder instance.

setAuthor

public ModifyCommandBuilder setAuthor(Person author)

Set the author for the new commit.

Returns:

This builder instance.

setBranch

public ModifyCommandBuilder setBranch(String branch)

Set the branch the changes should be made upon.

Returns:

This builder instance.

disableSigning

public ModifyCommandBuilder disableSigning()

Disables adding a verifiable signature to the modification commit.

Returns:

This builder instance.

Since:

2.4.0

setExpectedRevision

public ModifyCommandBuilder setExpectedRevision(String expectedRevision)

Set the expected revision of the branch, before the changes are applied. If the branch does not have the expected revision, a concurrent modification exception will be thrown when the command is executed and no changes will be applied.

Returns:

This builder instance.

useDefaultPath

public ModifyCommandBuilder useDefaultPath(boolean useDefaultPath)