com.atlassian.bitbucket.scm.git.command.mv

Interface GitMvBuilder

All Superinterfaces:

com.atlassian.bitbucket.scm.CommandBuilderSupport<GitMvBuilder>, GitCommandBuilderSupport<GitMvBuilder>

public interface GitMvBuilder
extends GitCommandBuilderSupport<GitMvBuilder>

A builder for the {code git mv} command

Since:

7.14

Field Summary

Fields inherited from interface com.atlassian.bitbucket.scm.git.command.GitCommandBuilderSupport

ENV_AUTHOR_DATE, ENV_AUTHOR_EMAIL, ENV_AUTHOR_NAME, ENV_COMMITTER_DATE, ENV_COMMITTER_EMAIL, ENV_COMMITTER_NAME

Method Summary

Modifier and Type	Method and Description
GitCommand<Void>	build()
GitMvBuilder	clearSources() Clears any sources that have been added, allowing the builder to be reused to construct multiple commands.
GitMvBuilder	destination(String value) Specifies the path that the source file, directory or symlink should be renamed to.
GitMvBuilder	force(boolean value)
GitMvBuilder	source(String value) Specifies a path to move to destination.
GitMvBuilder	sources(Iterable<String> values) Specifies path(s) to move to destination.
GitMvBuilder	sources(String value, String... moreValues) Specifies path(s) to move to destination.

Methods inherited from interface com.atlassian.bitbucket.scm.git.command.GitCommandBuilderSupport

alternate, alternates, alternates, author, author, author, build, commitish, committer, committer, committer, treeish, withConfiguration, withConfiguration, withConfiguration, withConfiguration

Methods inherited from interface com.atlassian.bitbucket.scm.CommandBuilderSupport

clearEnvironment, defaultExitHandler, exitHandler, removeEnvironment, withEnvironment

Method Detail

build

@Nonnull
GitCommand<Void> build()

clearSources

@Nonnull
GitMvBuilder clearSources()

Clears any sources that have been added, allowing the builder to be reused to construct multiple commands.

Returns:

the builder

destination

@Nonnull
GitMvBuilder destination(@Nonnull
                                  String value)

Specifies the path that the source file, directory or symlink should be renamed to.

Parameters:

value - the path to move the source to

Returns:

the builder

force

@Nonnull
GitMvBuilder force(boolean value)

Parameters:

value - true to force renaming or moving of a file even if the target exists

Returns:

the builder

source

@Nonnull
GitMvBuilder source(@Nonnull
                             String value)

Specifies a path to move to destination.

Parameters:

value - the file, directory or symlink to move

Returns:

the builder

sources

@Nonnull
GitMvBuilder sources(@Nonnull
                              String value,
                              @Nonnull
                              String... moreValues)

Specifies path(s) to move to destination. To rename a file, directory or symlink, only 1 path should be specified. If multiple source paths are specified, git mv will move the specified sources into the destination, which MUST be an existing directory.

Parameters:

value - the file, directory or symlink to move

moreValues - additional files, directories or symlinks to move

Returns:

the builder

sources

@Nonnull
GitMvBuilder sources(@Nonnull
                              Iterable<String> values)

Specifies path(s) to move to destination. To rename a file, directory or symlink, only 1 path should be specified. If multiple source paths are specified, git mv will move the specified sources into the destination, which MUST be an existing directory.

Parameters:

values - the files, directories and/or symlinks to move

Returns:

the builder