Package org.apache.maven.scm

Class ScmResult

java.lang.Object

org.apache.maven.scm.ScmResult

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AddScmResult, BlameScmResult, BranchScmResult, ChangeLogScmResult, CheckInScmResult, CheckOutScmResult, DiffScmResult, EditScmResult, ExportScmResult, InfoScmResult, ListScmResult, LoginScmResult, MkdirScmResult, RemoteInfoScmResult, RemoveScmResult, StatusScmResult, TagScmResult, UnEditScmResult, UntagScmResult, UpdateScmResult

public class ScmResult
extends Object
implements Serializable

Author:

Trygve Laugstøl

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	PASSWORD_PLACE_HOLDER

Constructor Summary

Constructors

Constructor	Description
ScmResult(String commandLine, String providerMessage, String commandOutput, boolean success)	ScmResult contructor.
ScmResult(ScmResult scmResult)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
String	getCommandLine()
String	getCommandOutput()
String	getProviderMessage()
boolean	isSuccess()

Methods inherited from class java.lang.Object

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

Field Detail

PASSWORD_PLACE_HOLDER

public static final String PASSWORD_PLACE_HOLDER

See Also:

Constant Field Values

Constructor Detail

ScmResult

public ScmResult(ScmResult scmResult)

Copy constructor.

Typically used from derived classes when wrapping a ScmResult into a specific type e.g. AddScmResult.

Parameters:

scmResult - not null

ScmResult

public ScmResult(String commandLine,
                 String providerMessage,
                 String commandOutput,
                 boolean success)

ScmResult contructor.

Parameters:

commandLine - the provider specific command line used

providerMessage - the provider message

commandOutput - the command output of the scm tool

success - true if the command is in success

Method Detail

isSuccess

public boolean isSuccess()

Returns:

true if the command was in success

getProviderMessage

public String getProviderMessage()

Returns:

a message from the provider. On success this would typically be null or an empty string. On failure, it would be the error message from the provider

getCommandOutput

public String getCommandOutput()

Returns:

output from Std.Out from the provider during execution of the command that resulted in this

getCommandLine

public String getCommandLine()

Returns:

the actual provider specific command that resulted in this