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:

AbstractCvsCheckOutCommand, BazaarCheckOutCommand, ClearCaseCheckOutCommand, GitCheckOutCommand, HgCheckOutCommand, IntegrityCheckOutCommand, JazzCheckOutCommand, LocalCheckOutCommand, PerforceCheckOutCommand, StarteamCheckOutCommand, SvnCheckOutCommand, SynergyCheckOutCommand, TfsCheckOutCommand, VssCheckOutCommand

public abstract class AbstractCheckOutCommand
extends AbstractCommand

Version:

$Id: AbstractCheckOutCommand.java 1054738 2011-01-03 20:40:39Z olamy $

Author:

Emmanuel Venisse, Trygve Laugstøl, Olivier Lamy

Field Summary

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

ROLE

Constructor Summary

AbstractCheckOutCommand()

Method Summary

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) Execute Check out command line.
ScmResult	executeCommand(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)

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

execute, getLogger, setLogger

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)

executeCheckOutCommand

protected abstract CheckOutScmResult executeCheckOutCommand(ScmProviderRepository repository,
                                                            ScmFileSet fileSet,
                                                            ScmVersion scmVersion,
                                                            boolean recursive)
                                                     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.

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