org.apache.maven.scm.command.checkout
Class CheckOutScmResult

java.lang.Object
  extended by org.apache.maven.scm.ScmResult
      extended by org.apache.maven.scm.command.checkout.CheckOutScmResult

public class CheckOutScmResult
extends ScmResult

Version:
$Id: CheckOutScmResult.java 520837 2007-03-21 11:04:06Z evenisse $
Author:
Trygve Laugstøl

Field Summary
protected  java.lang.String relativePathProjectDirectory
          The relative path of the directory of the checked out project in comparison to the checkout directory, or an empty String in case the checkout directory equals the project directory.
 
Constructor Summary
CheckOutScmResult(java.util.List checkedOutFiles, ScmResult result)
           
CheckOutScmResult(java.lang.String commandLine, java.util.List checkedOutFiles)
           
CheckOutScmResult(java.lang.String commandLine, java.util.List checkedOutFiles, java.lang.String relativePathProjectDirectory)
           
CheckOutScmResult(java.lang.String commandLine, java.lang.String providerMessage, java.lang.String commandOutput, boolean success)
           
 
Method Summary
 java.util.List getCheckedOutFiles()
           
 java.lang.String getRelativePathProjectDirectory()
           
 
Methods inherited from class org.apache.maven.scm.ScmResult
getCommandLine, getCommandOutput, getProviderMessage, isSuccess
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

relativePathProjectDirectory

protected java.lang.String relativePathProjectDirectory
The relative path of the directory of the checked out project in comparison to the checkout directory, or an empty String in case the checkout directory equals the project directory.

With most SCMs, this is just an empty String, meaning that the checkout directory equals the project directory. But there are cases (e.g. ClearCase) where within the checkout directory, the directory structure of the SCM system is repeated. E.g. if you check out the project "my/project" to "/some/dir", the project sources are actually checked out to "my/project/some/dir". In this example, relativePathProjectDirectory would contain "my/project".

Constructor Detail

CheckOutScmResult

public CheckOutScmResult(java.lang.String commandLine,
                         java.lang.String providerMessage,
                         java.lang.String commandOutput,
                         boolean success)

CheckOutScmResult

public CheckOutScmResult(java.lang.String commandLine,
                         java.util.List checkedOutFiles)

CheckOutScmResult

public CheckOutScmResult(java.lang.String commandLine,
                         java.util.List checkedOutFiles,
                         java.lang.String relativePathProjectDirectory)

CheckOutScmResult

public CheckOutScmResult(java.util.List checkedOutFiles,
                         ScmResult result)
Method Detail

getCheckedOutFiles

public java.util.List getCheckedOutFiles()

getRelativePathProjectDirectory

public java.lang.String getRelativePathProjectDirectory()
Returns:
the contents of relativePathProjectDirectory
See Also:
relativePathProjectDirectory


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.