org.apache.maven.scm.command.checkout

Class CheckOutScmResult

java.lang.Object

org.apache.maven.scm.ScmResult

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

LocalCheckOutScmResult

public class CheckOutScmResult
extends ScmResult

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<ScmFile>	checkedOutFiles
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.
private java.lang.String	revision
private static long	serialVersionUID

Fields inherited from class org.apache.maven.scm.ScmResult

PASSWORD_PLACE_HOLDER

Constructor Summary

Constructors

Constructor and Description
CheckOutScmResult(java.util.List<ScmFile> checkedOutFiles, ScmResult result)
CheckOutScmResult(java.lang.String commandLine, java.util.List<ScmFile> checkedOutFiles)
CheckOutScmResult(java.lang.String commandLine, java.util.List<ScmFile> checkedOutFiles, java.lang.String relativePathProjectDirectory)
CheckOutScmResult(java.lang.String commandLine, java.lang.String revision, java.util.List<ScmFile> checkedOutFiles)
CheckOutScmResult(java.lang.String commandLine, java.lang.String revision, java.util.List<ScmFile> checkedOutFiles, java.lang.String relativePathProjectDirectory)
CheckOutScmResult(java.lang.String commandLine, java.lang.String providerMessage, java.lang.String commandOutput, boolean success)

Method Summary

Modifier and Type	Method and Description
java.util.List<ScmFile>	getCheckedOutFiles()
java.lang.String	getRelativePathProjectDirectory()
java.lang.String	getRevision() Checked-out revision.

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

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

checkedOutFiles

private java.util.List<ScmFile> checkedOutFiles

revision

private java.lang.String revision

Since:

1.8

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<ScmFile> checkedOutFiles)

CheckOutScmResult

public CheckOutScmResult(java.lang.String commandLine,
                         java.lang.String revision,
                         java.util.List<ScmFile> checkedOutFiles)

CheckOutScmResult

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

CheckOutScmResult

public CheckOutScmResult(java.lang.String commandLine,
                         java.lang.String revision,
                         java.util.List<ScmFile> checkedOutFiles,
                         java.lang.String relativePathProjectDirectory)

CheckOutScmResult

public CheckOutScmResult(java.util.List<ScmFile> checkedOutFiles,
                         ScmResult result)

Method Detail

getCheckedOutFiles

public java.util.List<ScmFile> getCheckedOutFiles()

getRelativePathProjectDirectory

public java.lang.String getRelativePathProjectDirectory()

Returns:

the contents of relativePathProjectDirectory

See Also:

relativePathProjectDirectory

getRevision

public java.lang.String getRevision()

Checked-out revision. SCM's that have no revision per repository (or branch) should store null here.

Returns:

the revision that was checked out.

Since:

1.8