Package org.craftercms.studio.impl.v2.utils.git

Class GitCli

java.lang.Object

org.craftercms.studio.impl.v2.utils.git.GitCli

public class GitCli
extends Object

Allows doing Git operations throw the CLI.
If you ever use this class, please lock/synchronize the calls (hopefully with the GeneralLockService)

Since:

3.1.23

Author:

Sumer Jabri, Alfonso Vasquez

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	GitCli.GitCommandLine

Field Summary

Fields

Modifier and Type	Field	Description
final GitCliOutputExceptionResolver	COMMIT_EX_RESOLVER
final GitCliOutputExceptionResolver	DEFAULT_EX_RESOLVER

Constructor Summary

Constructors

Constructor	Description
GitCli()
GitCli(String gitProcName, int gitProcWaitForTimeoutSecs, int gitProcDestroyWaitForTimeoutSecs, int maxProcessOutputBytes)

Method Summary

Modifier and Type	Method	Description
void	add(File directory, String... paths)
void	clean(File repoDir, boolean force, boolean recursive)	Git clean (optionally -f)
String	commit(File directory, String author, String message, String... paths)
protected void	doExecuteGitCommand(GitCli.GitCommandLine commandLine)
boolean	isRepoClean(File directory)	Check if the repository is clean, meaning there are no changes to commit
void	resetHard(File repoDir)	Git reset --hard
void	restore(File directory, String... paths)	Remove the given paths from the index and discard changes

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_EX_RESOLVER

public final GitCliOutputExceptionResolver DEFAULT_EX_RESOLVER

COMMIT_EX_RESOLVER

public final GitCliOutputExceptionResolver COMMIT_EX_RESOLVER

Constructor Details

GitCli

public GitCli()

GitCli

public GitCli(String gitProcName,
 int gitProcWaitForTimeoutSecs,
 int gitProcDestroyWaitForTimeoutSecs,
 int maxProcessOutputBytes)

Method Details

doExecuteGitCommand

protected void doExecuteGitCommand(GitCli.GitCommandLine commandLine)
                            throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

add

public void add(File directory,
 String... paths)
         throws GitCliException

Throws:

GitCliException

restore

public void restore(File directory,
 String... paths)
             throws GitCliException

Remove the given paths from the index and discard changes

Parameters:

directory - the git repository directory

paths - the paths to restore

Throws:

GitCliException

commit

public String commit(File directory,
 String author,
 String message,
 String... paths)
              throws GitCliException

Throws:

GitCliException

isRepoClean

public boolean isRepoClean(File directory)
                    throws GitCliException

Check if the repository is clean, meaning there are no changes to commit

Parameters:

directory - the git repository directory

Returns:

true if the repository is clean, false otherwise

Throws:

GitCliException - if the git status command fails

resetHard

public void resetHard(File repoDir)
               throws GitCliException

Git reset --hard

Parameters:

repoDir - the git repository directory

Throws:

GitCliException - if the git reset command fails

clean

public void clean(File repoDir,
 boolean force,
 boolean recursive)
           throws GitCliException

Git clean (optionally -f)

Parameters:

repoDir - the git repository directory

force - true to force clean

recursive - true to clean directories recursively

Throws:

GitCliException - if the git clean command fails