com.atlassian.bitbucket.scm

Class ScmException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.atlassian.bitbucket.ServiceException

com.atlassian.bitbucket.scm.ScmException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AuthenticationFailedScmException, FeatureUnsupportedScmException, IncompleteScmException, MergeException, NotAuthorizedScmException, UnavailableScmException, UnsupportedScmException

public abstract class ScmException
extends ServiceException

Base class for exceptions thrown by the ScmService and other SCM components.

Plugin developers providing SCM implementations are encouraged to derive exceptions which will be propagated beyond their implementation boundaries from this exception.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ScmException(KeyedMessage message, String scmId)
protected	ScmException(KeyedMessage message, Throwable cause, String scmId)

Method Summary

Modifier and Type	Method and Description
String	getScmId() Retrieves the unique identifier for the SCM from which, or for which, this exception was thrown.

Methods inherited from class com.atlassian.bitbucket.ServiceException

getKeyedMessage, getLocalizedMessage, getMessageKey

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ScmException

protected ScmException(@Nonnull
                       KeyedMessage message,
                       @Nonnull
                       String scmId)

ScmException

protected ScmException(@Nonnull
                       KeyedMessage message,
                       @Nullable
                       Throwable cause,
                       @Nonnull
                       String scmId)

Method Detail

getScmId

@Nonnull
public String getScmId()

Retrieves the unique identifier for the SCM from which, or for which, this exception was thrown.

Returns:

the SCM identifier