VcsException (javadoc 2024.12-174331 API)

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - jetbrains.buildServer.vcs.VcsException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BranchExcludedException, BranchNotFoundException, CleanCheckoutDisabledException, IncrementalPatchImpossibleException, RevisionNotFoundException, VcsFileNotFoundException, VcsIncludeRulesException, VcsOperationRejectedException, VcsRootVcsException, VcsUrlValidator.MultiVcsException
```
public class VcsException
extends Exception
```
Exception is thrown when some problem occurred while processing vcs request.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`VcsException()`	Default constructor.
`VcsException(String message)`	Constructor with a description.
`VcsException(String message, Throwable cause)`	Constructor with a description and cause exception.
`VcsException(Throwable cause)`	Constructor with cause exception.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`isRecoverable()`	Indicates whether this error is recoverable (if true then operation can be repeated)
`void`	`setRecoverable(boolean recoverable)`	Sets whether this error is recoverable or not (false by default).
`VcsException`	`setRoot(Object root)`	Deprecated. core will take care to associate vcs exception and settings

Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, 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
  - VcsException
```
public VcsException()
```
    Default constructor.
  - VcsException
```
public VcsException(String message)
```
    Constructor with a description.
    
    Parameters:
    
    message - problem description.
  - VcsException
```
public VcsException(String message,
                    Throwable cause)
```
    Constructor with a description and cause exception.
    
    Parameters:
    
    message - problem description.
    
    cause - cause exception.
  - VcsException
```
public VcsException(Throwable cause)
```
    Constructor with cause exception.
    
    Parameters:
    
    cause - cause exception.
- Method Detail
  - isRecoverable
```
public boolean isRecoverable()
```
    Indicates whether this error is recoverable (if true then operation can be repeated)
    
    Returns:
    
    true if error is recoverable
  - setRecoverable
```
public void setRecoverable(boolean recoverable)
```
    Sets whether this error is recoverable or not (false by default).
    
    Parameters:
    
    recoverable - true if error is recoverable
  - setRoot
```
@NotNull
@Deprecated
public VcsException setRoot(@NotNull
                            Object root)
```
    Deprecated.
    core will take care to associate vcs exception and settings
    
    This method is left here only for compatibility with older versions
    
    Parameters:
    
    root - deprecated
    
    Since:
    
    2.0