Package org.apache.maven.scm.provider.git.gitexe.command.checkout

Class GitCheckOutCommand

java.lang.Object

org.apache.maven.scm.command.AbstractCommand

org.apache.maven.scm.command.checkout.AbstractCheckOutCommand

org.apache.maven.scm.provider.git.gitexe.command.checkout.GitCheckOutCommand

All Implemented Interfaces:

Command, GitCommand

public class GitCheckOutCommand
extends AbstractCheckOutCommand
implements GitCommand

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Map<java.lang.String,java.lang.String>	environmentVariables

Fields inherited from class org.apache.maven.scm.command.AbstractCommand

logger

Fields inherited from interface org.apache.maven.scm.command.Command

ROLE

Constructor Summary

Constructors

Constructor	Description
GitCheckOutCommand(java.util.Map<java.lang.String,java.lang.String> environmentVariables)

Method Summary

Modifier and Type	Method	Description
private org.codehaus.plexus.util.cli.Commandline	createCloneCommand(GitScmProviderRepository repository, java.io.File workingDirectory, ScmVersion version, boolean binary, boolean shallow)	Create a git-clone repository command.
static org.codehaus.plexus.util.cli.Commandline	createCommandLine(GitScmProviderRepository repository, java.io.File workingDirectory, ScmVersion version)
private org.codehaus.plexus.util.cli.Commandline	createPullCommand(GitScmProviderRepository repository, java.io.File workingDirectory, ScmVersion version)	Create a git fetch or git pull repository command.
protected CheckOutScmResult	executeCheckOutCommand(ScmProviderRepository repo, ScmFileSet fileSet, ScmVersion version, boolean recursive, boolean shallow)	The overridden executeCommand(ScmProviderRepository, ScmFileSet, CommandParameters) in this class will not call this method!
ScmResult	executeCommand(ScmProviderRepository repo, ScmFileSet fileSet, CommandParameters parameters)	For git, the given repository is a remote one.
private void	forceBinary(org.codehaus.plexus.util.cli.Commandline commandLine, boolean binary)

Methods inherited from class org.apache.maven.scm.command.checkout.AbstractCheckOutCommand

executeCheckOutCommand

Methods inherited from class org.apache.maven.scm.command.AbstractCommand

execute

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.maven.scm.command.Command

execute

Field Detail

environmentVariables

private final java.util.Map<java.lang.String,java.lang.String> environmentVariables

Constructor Detail

GitCheckOutCommand

public GitCheckOutCommand(java.util.Map<java.lang.String,java.lang.String> environmentVariables)

Method Detail

executeCommand

public ScmResult executeCommand(ScmProviderRepository repo,
                                ScmFileSet fileSet,
                                CommandParameters parameters)
                         throws ScmException

For git, the given repository is a remote one. We have to clone it first if the working directory does not contain a git repo yet, otherwise we have to git-pull it.

TODO We currently assume a '.git' directory, so this does not work for --bare repos

Overrides:

executeCommand in class AbstractCheckOutCommand

Throws:

ScmException

createCommandLine

public static org.codehaus.plexus.util.cli.Commandline createCommandLine(GitScmProviderRepository repository,
                                                                         java.io.File workingDirectory,
                                                                         ScmVersion version)

createCloneCommand

private org.codehaus.plexus.util.cli.Commandline createCloneCommand(GitScmProviderRepository repository,
                                                                    java.io.File workingDirectory,
                                                                    ScmVersion version,
                                                                    boolean binary,
                                                                    boolean shallow)

Create a git-clone repository command.

forceBinary

private void forceBinary(org.codehaus.plexus.util.cli.Commandline commandLine,
                         boolean binary)

createPullCommand

private org.codehaus.plexus.util.cli.Commandline createPullCommand(GitScmProviderRepository repository,
                                                                   java.io.File workingDirectory,
                                                                   ScmVersion version)

Create a git fetch or git pull repository command.

executeCheckOutCommand

protected CheckOutScmResult executeCheckOutCommand(ScmProviderRepository repo,
                                                   ScmFileSet fileSet,
                                                   ScmVersion version,
                                                   boolean recursive,
                                                   boolean shallow)
                                            throws ScmException

The overridden executeCommand(ScmProviderRepository, ScmFileSet, CommandParameters) in this class will not call this method!

Execute Check out command line.

Specified by:

executeCheckOutCommand in class AbstractCheckOutCommand

Parameters:

repo - not null

fileSet - not null

version - not null

recursive - true if recursive check out is wanted, false otherwise

shallow - true if shallow check out is wanted, false otherwise

Returns:

the checkout result

Throws:

ScmException - if any