Add a hint on the purpose of JGitInternalException to the constructor

In code review we often see uses of JGitInternalException where a high
level GitAPIException would be more appropriate. Hopefully the word
low-level in the constructor comment will lead to fewer such cases.

Change-Id: Id5ec7897535f6c5c5f0bd153fe0ff15c65083474
This commit is contained in:
Robin Rosenberg 2012-10-08 06:27:30 +02:00
parent 6da9473fe3
commit 47a9b996c7
1 changed files with 4 additions and 0 deletions

View File

@ -60,6 +60,8 @@ public class JGitInternalException extends RuntimeException {
private static final long serialVersionUID = 1L;
/**
* Construct an exception for low-level internal exceptions
*
* @param message
* @param cause
*/
@ -68,6 +70,8 @@ public JGitInternalException(String message, Throwable cause) {
}
/**
* Construct an exception for low-level internal exceptions
*
* @param message
*/
public JGitInternalException(String message) {