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
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • success

      private final boolean success

    • providerMessage

      private final String providerMessage

    • commandOutput

      private final String commandOutput

    • commandLine

      private final String commandLine

    • PASSWORD_PLACE_HOLDER

      public static final String PASSWORD_PLACE_HOLDER
      See Also:

    • patternForUserColonPasswordAtHost

      private Pattern patternForUserColonPasswordAtHost

  • Constructor Details

    • 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 Details

    • 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

    • masked

      private String masked(String commandOutput)