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

Class JGitCheckOutCommand

java.lang.Object

org.apache.maven.scm.command.AbstractCommand

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

org.apache.maven.scm.provider.git.jgit.command.checkout.JGitCheckOutCommand

All Implemented Interfaces:

Command, GitCommand, CustomizableSshSessionFactoryCommand

public class JGitCheckOutCommand
extends AbstractCheckOutCommand
implements GitCommand, CustomizableSshSessionFactoryCommand

Since:

1.9

Author:

Mark Struberg, Dominik Bartholdi (imod)

Field Summary

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
JGitCheckOutCommand()

Method Summary

Modifier and Type	Method	Description
protected CheckOutScmResult	executeCheckOutCommand(ScmProviderRepository repo, ScmFileSet fileSet, ScmVersion version, boolean recursive, boolean shallow)	For git, the given repository is a remote one.
void	setSshSessionFactorySupplier(BiFunction<GitScmProviderRepository,org.slf4j.Logger,ScmProviderAwareSshdSessionFactory> sshSessionFactorySupplier)	Sets a different supplier for the SSH session factory that will be used by this command.

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

executeCheckOutCommand, executeCommand

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

Constructor Detail

JGitCheckOutCommand

public JGitCheckOutCommand()

Method Detail

setSshSessionFactorySupplier

public void setSshSessionFactorySupplier(BiFunction<GitScmProviderRepository,org.slf4j.Logger,ScmProviderAwareSshdSessionFactory> sshSessionFactorySupplier)

Description copied from interface: CustomizableSshSessionFactoryCommand

Sets a different supplier for the SSH session factory that will be used by this command. By default it uses ScmProviderAwareSshdSessionFactory.

Specified by:

setSshSessionFactorySupplier in interface CustomizableSshSessionFactoryCommand

Parameters:

sshSessionFactorySupplier - a function that takes a GitScmProviderRepository and Logger and returns a ScmProviderAwareSshdSessionFactory

executeCheckOutCommand

protected CheckOutScmResult executeCheckOutCommand(ScmProviderRepository repo,
                                                   ScmFileSet fileSet,
                                                   ScmVersion version,
                                                   boolean recursive,
                                                   boolean shallow)
                                            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.

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