Package com.atlassian.bitbucket.scm.git.worktree

Interface GitWorkTree

All Superinterfaces:

AutoCloseable

public interface GitWorkTree
extends AutoCloseable

Represents a git repository work tree that can be used to create new commits. The basic flow for creating one or more commits is as follows:

• Create a new GitWorkTreeBuilder using GitWorkTreeBuilderFactory.builder(Repository) for the repository in question.
• Specify the commit the work tree should check out and execute the change operation in the context of a temporary GitWorkTree. The work tree on disk is automatically deleted after the operation completes.
• Edit, add files, or use builder() to manipulate the index directly though git operations such as rm and mv and to create new commits.
• Publish the HEAD commit of the work tree to the repository, specifying the target branch to update.

Note that a GitWorkTree is a temporary location on disk that is deleted after the change operation completes, or when the GitWorkTree expires. Each GitWorkTree is configured with an expiry to prevent stale work tree directories from building up in case of system failures.

Since:

7.14

Method Summary

Modifier and Type	Method	Description
GitWorkTreeCommandBuilder	builder()
void	close()	Closes and deletes the work tree
Instant	getExpiry()
com.atlassian.bitbucket.repository.Repository	getRepository()
boolean	isExpired()
void	mkdir(String relativePath)	Creates a new directory, and all of its parent directories, at relativePath.
void	publish(PublishGitWorkTreeParameters parameters)	Fetches newly created commits into the repository, invokes any registered repository hooks and, if not vetoed, updates the requested branch.
void	write(String relativePath, Charset cs, com.atlassian.bitbucket.io.IoConsumer<Writer> callback)	Writes to the file located at relativePath.
void	writeFrom(String relativePath, Charset cs, com.atlassian.bitbucket.io.IoSupplier<Reader> contentSupplier)	Writes to the file located at relativePath.

Method Details

builder

@Nonnull
GitWorkTreeCommandBuilder builder()

Returns:

a new GitWorkTreeCommandBuilder that can be used to build and execute git operations in the work tree

Throws:

IllegalStateException - if the work tree has been closed or has expired

close

void close()

Closes and deletes the work tree

Specified by:

close in interface AutoCloseable

getExpiry

@Nonnull
Instant getExpiry()

Returns:

the Instant at which this WorkTree expires and becomes available for clean up

getRepository

@Nonnull
com.atlassian.bitbucket.repository.Repository getRepository()

Returns:

the repository for which the work tree was created

isExpired

boolean isExpired()

Returns:

true if this WorkTree has expired and is available for clean up

publish

void publish(@Nonnull
 PublishGitWorkTreeParameters parameters)

Fetches newly created commits into the repository, invokes any registered repository hooks and, if not vetoed, updates the requested branch.

Parameters:

parameters - describes which RepositoryHookRequest to create and what refs to update

Throws:

IllegalStateException - if the work tree has been closed or has expired

mkdir

void mkdir(@Nonnull
 String relativePath)
    throws IOException

Creates a new directory, and all of its parent directories, at relativePath. If a directory already exists at relativePath, the method simply returns.

Parameters:

relativePath - the path at which a directory should be created, relative to the repository root

Throws:

FileAlreadyExistsException - if relativePath exists but is not a directory

IOException - if an I/O error occurs

IllegalStateException - if the work tree has been closed or has expired

write

void write(@Nonnull
 String relativePath,
 @Nonnull
 Charset cs,
 @Nonnull
 com.atlassian.bitbucket.io.IoConsumer<Writer> callback)
    throws IOException

Writes to the file located at relativePath.

If file already exists, its contents will be overwritten.

Parameters:

relativePath - the path, relative to the work tree root, of the file to edit

cs - the Charset with which to open the Writer

callback - callback to hand the Writer to

Throws:

IOException - if the mutator fails, or if relativePath exists, but cannot be opened

IllegalStateException - if the work tree has been closed or has expired

writeFrom

void writeFrom(@Nonnull
 String relativePath,
 @Nonnull
 Charset cs,
 @Nonnull
 com.atlassian.bitbucket.io.IoSupplier<Reader> contentSupplier)
        throws IOException

Writes to the file located at relativePath.

If file already exists, its contents will be overwritten.

Parameters:

relativePath - the path, relative to the work tree root, of the file to edit

cs - the Charset to use when writing the file

contentSupplier - supplier of a Reader from which the new contents should be read

Throws:

IOException - if the mutator fails, or if relativePath exists, but cannot be opened

IllegalStateException - if the work tree has been closed or has expired