org.apache.maven.scm.provider.integrity.command.checkout

Class IntegrityCheckOutCommand

java.lang.Object

org.apache.maven.scm.command.AbstractCommand

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

org.apache.maven.scm.provider.integrity.command.checkout.IntegrityCheckOutCommand

All Implemented Interfaces:

Command

public class IntegrityCheckOutCommand
extends AbstractCheckOutCommand

MKS Integrity implementation for Maven's AbstractCheckOutCommand
The Checkout command will create a fresh sandbox in the checkoutDirectory
Since, Maven deletes the prior checkout folder, this command will check for a prior sandbox in the checkout directory and if a sandbox was found, then the command will resynchronize the sandbox.

Since:

1.6

Author:

Cletus D'Souza

Field Summary

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

ROLE

Constructor Summary

Constructors

Constructor and Description
IntegrityCheckOutCommand()

Method Summary

Modifier and Type

Method and Description

CheckOutScmResult

executeCheckOutCommand(ScmProviderRepository repository, ScmFileSet fileSet, ScmVersion scmVersion, boolean recursive, boolean shallow) Overridden function that performs a checkout (resynchronize) operation against an MKS Source Project This function ignores the scmVerion and recursive arguments passed into this function as while there is a suitable equivalent to checkout/resynchronize by label/revision, it doesn't make sense for the way Maven seems to want to execute 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, getLogger, setLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

IntegrityCheckOutCommand

public IntegrityCheckOutCommand()

Method Detail

executeCheckOutCommand

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

Overridden function that performs a checkout (resynchronize) operation against an MKS Source Project This function ignores the scmVerion and recursive arguments passed into this function as while there is a suitable equivalent to checkout/resynchronize by label/revision, it doesn't make sense for the way Maven seems to want to execute this command. Hence we will create/resynchronize a sandbox, which will be recursive in nature. If the user chooses to checkout a specific versioned configuration (checkpoint), then that information will be contained in the Configuration Path obtained from the IntegrityScmProviderRepository

Specified by:

executeCheckOutCommand in class AbstractCheckOutCommand

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