Package org.apache.maven.scm.command.checkout

Class AbstractCheckOutCommand

java.lang.Object

org.apache.maven.scm.command.AbstractCommand

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

All Implemented Interfaces:

Command

Direct Known Subclasses:

GitCheckOutCommand, HgCheckOutCommand, JGitCheckOutCommand, LocalCheckOutCommand, SvnCheckOutCommand

public abstract class AbstractCheckOutCommand
extends AbstractCommand

Author:

Emmanuel Venisse, Trygve Laugstøl, Olivier Lamy

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

Method Summary

Modifier and Type	Method	Description
protected CheckOutScmResult	executeCheckOutCommand(ScmProviderRepository repository, ScmFileSet fileSet, ScmVersion scmVersion)	Execute Check out command line in a recursive check out way.
protected abstract CheckOutScmResult	executeCheckOutCommand(ScmProviderRepository repository, ScmFileSet fileSet, ScmVersion scmVersion, boolean recursive, boolean shallow)	Execute Check out command line.
ScmResult	executeCommand(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)

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

Constructor Detail

AbstractCheckOutCommand

public AbstractCheckOutCommand()

Method Detail

executeCheckOutCommand

protected CheckOutScmResult executeCheckOutCommand(ScmProviderRepository repository,
                                                   ScmFileSet fileSet,
                                                   ScmVersion scmVersion)
                                            throws ScmException

Execute Check out command line in a recursive check out way.

Parameters:

repository - not null

fileSet - not null

scmVersion - not null

Returns:

the checkout result

Throws:

ScmException - if any

See Also:

executeCheckOutCommand(ScmProviderRepository, ScmFileSet, ScmVersion, boolean, boolean)

executeCheckOutCommand

protected abstract CheckOutScmResult executeCheckOutCommand(ScmProviderRepository repository,
                                                            ScmFileSet fileSet,
                                                            ScmVersion scmVersion,
                                                            boolean recursive,
                                                            boolean shallow)
                                                     throws ScmException

Execute Check out command line.

Parameters:

repository - not null

fileSet - not null

scmVersion - 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

Since:

1.1.1

executeCommand

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

Specified by:

executeCommand in class AbstractCommand

Throws:

ScmException