motiejus
/
jgit
1
Fork 0
Code Releases Activity

Fix javadoc in org.eclipse.jgit errors package 

Change-Id: I46aa5c3073b99a311a1a97fc57d8f29d32524482
Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>
This commit is contained in:
Matthias Sohn 2017-12-18 11:34:31 +01:00
parent c281692c06
commit 6478577899
31 changed files with 156 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
org.eclipse.jgit/src/org/eclipse/jgit/errors/AmbiguousObjectException.java
View File

@ -51,7 +51,9 @@
import org.eclipse.jgit.lib.AbbreviatedObjectId;
import org.eclipse.jgit.lib.ObjectId;
/** An {@link AbbreviatedObjectId} cannot be extended. */
/**
* An {@link org.eclipse.jgit.lib.AbbreviatedObjectId} cannot be extended.
*/
public class AmbiguousObjectException extends IOException {
private static final long serialVersionUID = 1L;
@ -76,12 +78,20 @@ public AmbiguousObjectException(final AbbreviatedObjectId id,
this.candidates = candidates;
}
/** @return the AbbreviatedObjectId that has more than one result. */
/**
* Get the {@code AbbreviatedObjectId} that has more than one result
*
* @return the {@code AbbreviatedObjectId} that has more than one result
*/
public AbbreviatedObjectId getAbbreviatedObjectId() {
return missing;
}
/** @return the matching candidates (or at least a subset of them). */
/**
* Get the matching candidates (or at least a subset of them)
*
* @return the matching candidates (or at least a subset of them)
*/
public Collection<ObjectId> getCandidates() {
return candidates;
}

3
org.eclipse.jgit/src/org/eclipse/jgit/errors/CancelledException.java
View File

@ -54,7 +54,10 @@ public class CancelledException extends IOException {
private static final long serialVersionUID = 1L;
/**
* Constructor for CancelledException
*
* @param message
* error message
*/
public CancelledException(String message) {
super(message);

4
org.eclipse.jgit/src/org/eclipse/jgit/errors/CheckoutConflictException.java
View File

@ -62,6 +62,7 @@ public class CheckoutConflictException extends IOException {
* Construct a CheckoutConflictException for the specified file
*
* @param file
* relative path of a file
*/
public CheckoutConflictException(String file) {
super(MessageFormat.format(JGitText.get().checkoutConflictWithFile, file));
@ -72,6 +73,7 @@ public CheckoutConflictException(String file) {
* Construct a CheckoutConflictException for the specified set of files
*
* @param files
* an array of relative file paths
*/
public CheckoutConflictException(String[] files) {
super(MessageFormat.format(JGitText.get().checkoutConflictWithFiles, buildList(files)));
@ -79,6 +81,8 @@ public CheckoutConflictException(String[] files) {
}
/**
* Get the relative paths of the conflicting files
*
* @return the relative paths of the conflicting files (relative to the
* working directory root).
* @since 4.4

6
org.eclipse.jgit/src/org/eclipse/jgit/errors/CommandFailedException.java
View File

@ -54,6 +54,8 @@ public class CommandFailedException extends Exception {
private int returnCode;
/**
* Constructor for CommandFailedException
*
* @param returnCode
* return code returned by the command
* @param message
@ -65,6 +67,8 @@ public CommandFailedException(int returnCode, String message) {
}
/**
* Constructor for CommandFailedException
*
* @param returnCode
* return code returned by the command
* @param message
@ -79,6 +83,8 @@ public CommandFailedException(int returnCode, String message,
}
/**
* Get return code returned by the command
*
* @return return code returned by the command
*/
public int getReturnCode() {

4
org.eclipse.jgit/src/org/eclipse/jgit/errors/CompoundException.java
View File

@ -50,7 +50,9 @@
import org.eclipse.jgit.internal.JGitText;
/** An exception detailing multiple reasons for failure. */
/**
* An exception detailing multiple reasons for failure.
*/
public class CompoundException extends Exception {
private static final long serialVersionUID = 1L;

4
org.eclipse.jgit/src/org/eclipse/jgit/errors/ConfigInvalidException.java
View File

@ -43,7 +43,9 @@
package org.eclipse.jgit.errors;
/** Indicates a text string is not a valid Git style configuration. */
/**
* Indicates a text string is not a valid Git style configuration.
*/
public class ConfigInvalidException extends Exception {
private static final long serialVersionUID = 1L;

8
org.eclipse.jgit/src/org/eclipse/jgit/errors/CorruptObjectException.java
View File

@ -86,7 +86,9 @@ public CorruptObjectException(ObjectChecker.ErrorType type, AnyObjectId id,
* object id
*
* @param id
* a {@link org.eclipse.jgit.lib.AnyObjectId}
* @param why
* error message
*/
public CorruptObjectException(AnyObjectId id, String why) {
super(MessageFormat.format(JGitText.get().objectIsCorrupt, id.name(), why));
@ -97,7 +99,9 @@ public CorruptObjectException(AnyObjectId id, String why) {
* object id
*
* @param id
* a {@link org.eclipse.jgit.lib.ObjectId}
* @param why
* error message
*/
public CorruptObjectException(ObjectId id, String why) {
super(MessageFormat.format(JGitText.get().objectIsCorrupt, id.name(), why));
@ -108,6 +112,7 @@ public CorruptObjectException(ObjectId id, String why) {
* with a specific object id.
*
* @param why
* error message
*/
public CorruptObjectException(String why) {
super(why);
@ -129,7 +134,8 @@ public CorruptObjectException(String why, Throwable cause) {
}
/**
* Specific error condition identified by {@link ObjectChecker}.
* Specific error condition identified by
* {@link org.eclipse.jgit.lib.ObjectChecker}.
*
* @return error condition or null.
* @since 4.2

11
org.eclipse.jgit/src/org/eclipse/jgit/errors/DiffInterruptedException.java
View File

@ -53,8 +53,12 @@ public class DiffInterruptedException extends RuntimeException {
private static final long serialVersionUID = 1L;
/**
* Constructor for DiffInterruptedException
*
* @param message
* error message
* @param cause
* a {@link java.lang.Throwable}
* @since 4.1
*/
public DiffInterruptedException(String message, Throwable cause) {
@ -62,14 +66,19 @@ public DiffInterruptedException(String message, Throwable cause) {
}
/**
* Constructor for DiffInterruptedException
*
* @param message
* error message
* @since 4.1
*/
public DiffInterruptedException(String message) {
super(message);
}
/** Indicates that the thread computing a diff was interrupted. */
/**
* Indicates that the thread computing a diff was interrupted.
*/
public DiffInterruptedException() {
super();
}

12
org.eclipse.jgit/src/org/eclipse/jgit/errors/DirCacheNameConflictException.java
View File

@ -68,12 +68,20 @@ public DirCacheNameConflictException(String path1, String path2) {
this.path2 = path2;
}
/** @return one of the paths that has a conflict. */
/**
* Get one of the paths that has a conflict
*
* @return one of the paths that has a conflict
*/
public String getPath1() {
return path1;
}
/** @return another path that has a conflict. */
/**
* Get another path that has a conflict
*
* @return another path that has a conflict
*/
public String getPath2() {
return path2;
}

3
org.eclipse.jgit/src/org/eclipse/jgit/errors/IllegalTodoFileModification.java
View File

@ -51,7 +51,10 @@ public class IllegalTodoFileModification extends Exception {
private static final long serialVersionUID = 1L;
/**
* Constructor for IllegalTodoFileModification
*
* @param msg
* error message
*/
public IllegalTodoFileModification(final String msg) {
super(msg);

4
org.eclipse.jgit/src/org/eclipse/jgit/errors/InvalidObjectIdException.java
View File

@ -69,8 +69,10 @@ public InvalidObjectIdException(byte[] bytes, int offset, int length) {
}
/**
* @param id the invalid id.
* Constructor for InvalidObjectIdException
*
* @param id
* the invalid id.
* @since 4.1
*/
public InvalidObjectIdException(String id) {

5
org.eclipse.jgit/src/org/eclipse/jgit/errors/InvalidPatternException.java
View File

@ -47,7 +47,6 @@
/**
* Thrown when a pattern passed in an argument was wrong.
*
*/
public class InvalidPatternException extends Exception {
private static final long serialVersionUID = 1L;
@ -55,6 +54,8 @@ public class InvalidPatternException extends Exception {
private final String pattern;
/**
* Constructor for InvalidPatternException
*
* @param message
* explains what was wrong with the pattern.
* @param pattern
@ -66,6 +67,8 @@ public InvalidPatternException(String message, String pattern) {
}
/**
* Get the invalid pattern
*
* @return the invalid pattern.
*/
public String getPattern() {

21
org.eclipse.jgit/src/org/eclipse/jgit/errors/LargeObjectException.java
View File

@ -49,13 +49,17 @@
import org.eclipse.jgit.lib.AnyObjectId;
import org.eclipse.jgit.lib.ObjectId;
/** An object is too big to load into memory as a single byte array. */
/**
* An object is too big to load into memory as a single byte array.
*/
public class LargeObjectException extends RuntimeException {
private static final long serialVersionUID = 1L;
private ObjectId objectId;
/** Create a large object exception, where the object isn't known. */
/**
* Create a large object exception, where the object isn't known.
*/
public LargeObjectException() {
// Do nothing.
}
@ -71,12 +75,20 @@ public LargeObjectException(AnyObjectId id) {
setObjectId(id);
}
/** @return identity of the object that is too large; may be null. */
/**
* Get identity of the object that is too large; may be null
*
* @return identity of the object that is too large; may be null
*/
public ObjectId getObjectId() {
return objectId;
}
/** @return either the hex encoded name of the object, or 'unknown object'. */
/**
* Get the hex encoded name of the object, or 'unknown object'
*
* @return either the hex encoded name of the object, or 'unknown object'
*/
protected String getObjectName() {
if (getObjectId() != null)
return getObjectId().name();
@ -94,6 +106,7 @@ public void setObjectId(AnyObjectId id) {
objectId = id.copy();
}
/** {@inheritDoc} */
@Override
public String getMessage() {
return MessageFormat.format(JGitText.get().largeObjectException,

5
org.eclipse.jgit/src/org/eclipse/jgit/errors/LockFailedException.java
View File

@ -57,12 +57,15 @@ public class LockFailedException extends IOException {
private File file;
/**
* Constructor for LockFailedException
*
* @param file
* file that could not be locked
* @param message
* exception message
* @param cause
* cause, for later retrieval by {@link Throwable#getCause()}
* cause, for later retrieval by
* {@link java.lang.Throwable#getCause()}
* @since 4.1
*/
public LockFailedException(File file, String message, Throwable cause) {

6
org.eclipse.jgit/src/org/eclipse/jgit/errors/MissingObjectException.java
View File

@ -100,7 +100,11 @@ public MissingObjectException(final AbbreviatedObjectId id, final int type) {
missing = null;
}
/** @return the ObjectId that was not found. */
/**
* Get the ObjectId that was not found
*
* @return the ObjectId that was not found
*/
public ObjectId getObjectId() {
return missing;
}

2
org.eclipse.jgit/src/org/eclipse/jgit/errors/NoClosingBracketException.java
View File

@ -58,6 +58,8 @@ public class NoClosingBracketException extends InvalidPatternException {
private static final long serialVersionUID = 1L;
/**
* Constructor for NoClosingBracketException
*
* @param indexOfOpeningBracket
* the position of the [ character which has no ] character.
* @param openingBracket

2
org.eclipse.jgit/src/org/eclipse/jgit/errors/NoMergeBaseException.java
View File

@ -118,6 +118,8 @@ public NoMergeBaseException(MergeBaseFailureReason reason, String message,
}
/**
* Get the reason why no merge base could be found
*
* @return the reason why no merge base could be found
*/
public MergeBaseFailureReason getReason() {

8
org.eclipse.jgit/src/org/eclipse/jgit/errors/NoWorkTreeException.java
View File

@ -44,15 +44,17 @@
package org.eclipse.jgit.errors;
import org.eclipse.jgit.internal.JGitText;
import org.eclipse.jgit.lib.Repository;
/**
* Indicates a {@link Repository} has no working directory, and is thus bare.
* Indicates a {@link org.eclipse.jgit.lib.Repository} has no working directory,
* and is thus bare.
*/
public class NoWorkTreeException extends IllegalStateException {
private static final long serialVersionUID = 1L;
/** Creates an exception indicating there is no work tree for a repository. */
/**
* Creates an exception indicating there is no work tree for a repository.
*/
public NoWorkTreeException() {
super(JGitText.get().bareRepositoryNoWorkdirAndIndex);
}

4
org.eclipse.jgit/src/org/eclipse/jgit/errors/PackInvalidException.java
View File

@ -49,7 +49,9 @@
import org.eclipse.jgit.internal.JGitText;
/** Thrown when a PackFile previously failed and is known to be unusable */
/**
* Thrown when a PackFile previously failed and is known to be unusable
*/
public class PackInvalidException extends IOException {
private static final long serialVersionUID = 1L;

4
org.eclipse.jgit/src/org/eclipse/jgit/errors/PackMismatchException.java
View File

@ -45,7 +45,9 @@
import java.io.IOException;
/** Thrown when a PackFile no longer matches the PackIndex. */
/**
* Thrown when a PackFile no longer matches the PackIndex.
*/
public class PackMismatchException extends IOException {
private static final long serialVersionUID = 1L;

4
org.eclipse.jgit/src/org/eclipse/jgit/errors/RepositoryNotFoundException.java
View File

@ -48,7 +48,9 @@
import org.eclipse.jgit.internal.JGitText;
/** Indicates a local repository does not exist. */
/**
* Indicates a local repository does not exist.
*/
public class RepositoryNotFoundException extends TransportException {
private static final long serialVersionUID = 1L;

10
org.eclipse.jgit/src/org/eclipse/jgit/errors/RevWalkException.java
View File

@ -45,16 +45,16 @@
package org.eclipse.jgit.errors;
import org.eclipse.jgit.internal.JGitText;
import org.eclipse.jgit.revwalk.RevWalk;
/**
* Indicates a checked exception was thrown inside of {@link RevWalk}.
* Indicates a checked exception was thrown inside of
* {@link org.eclipse.jgit.revwalk.RevWalk}.
* <p>
* Usually this exception is thrown from the Iterator created around a RevWalk
* instance, as the Iterator API does not allow checked exceptions to be thrown
* from hasNext() or next(). The {@link Exception#getCause()} of this exception
* is the original checked exception that we really wanted to throw back to the
* application for handling and recovery.
* from hasNext() or next(). The {@link java.lang.Exception#getCause()} of this
* exception is the original checked exception that we really wanted to throw
* back to the application for handling and recovery.
*/
public class RevWalkException extends RuntimeException {
private static final long serialVersionUID = 1L;

1
org.eclipse.jgit/src/org/eclipse/jgit/errors/RevisionSyntaxException.java
View File

@ -77,6 +77,7 @@ public RevisionSyntaxException(String message, String revstr) {
this.revstr = revstr;
}
/** {@inheritDoc} */
@Override
public String toString() {
return super.toString() + ":" + revstr; //$NON-NLS-1$

4
org.eclipse.jgit/src/org/eclipse/jgit/errors/StoredObjectRepresentationNotAvailableException.java
View File

@ -45,7 +45,9 @@
import org.eclipse.jgit.internal.storage.pack.ObjectToPack;
/** A previously selected representation is no longer available. */
/**
* A previously selected representation is no longer available.
*/
public class StoredObjectRepresentationNotAvailableException extends Exception {
private static final long serialVersionUID = 1L;

6
org.eclipse.jgit/src/org/eclipse/jgit/errors/TooLargeObjectInPackException.java
View File

@ -48,7 +48,9 @@
import org.eclipse.jgit.internal.JGitText;
import org.eclipse.jgit.transport.URIish;
/** Thrown when PackParser finds an object larger than a predefined limit */
/**
* Thrown when PackParser finds an object larger than a predefined limit
*/
public class TooLargeObjectInPackException extends TransportException {
private static final long serialVersionUID = 1L;
@ -72,7 +74,9 @@ public TooLargeObjectInPackException(long maxObjectSizeLimit) {
* too large object is known.
*
* @param objectSize
* a long.
* @param maxObjectSizeLimit
* a long.
*/
public TooLargeObjectInPackException(long objectSize,
long maxObjectSizeLimit) {

10
org.eclipse.jgit/src/org/eclipse/jgit/errors/TranslationBundleException.java
View File

@ -43,7 +43,6 @@
package org.eclipse.jgit.errors;
import java.util.Locale;
import java.util.ResourceBundle;
/**
* Common base class for all translation bundle related exceptions.
@ -55,7 +54,8 @@ public abstract class TranslationBundleException extends RuntimeException {
private final Locale locale;
/**
* To construct an instance of {@link TranslationBundleException}
* Construct an instance of
* {@link org.eclipse.jgit.errors.TranslationBundleException}
*
* @param message
* exception message
@ -65,7 +65,7 @@ public abstract class TranslationBundleException extends RuntimeException {
* locale for which the exception occurred
* @param cause
* original exception that caused this exception. Usually thrown
* from the {@link ResourceBundle} class.
* from the {@link java.util.ResourceBundle} class.
*/
protected TranslationBundleException(String message, Class bundleClass, Locale locale, Exception cause) {
super(message, cause);
@ -74,6 +74,8 @@ protected TranslationBundleException(String message, Class bundleClass, Locale l
}
/**
* Get bundle class
*
* @return bundle class for which the exception occurred
*/
final public Class getBundleClass() {
@ -81,6 +83,8 @@ final public Class getBundleClass() {
}
/**
* Get locale for which the exception occurred
*
* @return locale for which the exception occurred
*/
final public Locale getLocale() {

9
org.eclipse.jgit/src/org/eclipse/jgit/errors/TranslationBundleLoadingException.java
View File

@ -43,7 +43,6 @@
package org.eclipse.jgit.errors;
import java.util.Locale;
import java.util.ResourceBundle;
/**
* This exception will be thrown when a translation bundle loading
@ -53,8 +52,9 @@ public class TranslationBundleLoadingException extends TranslationBundleExceptio
private static final long serialVersionUID = 1L;
/**
* Construct a {@link TranslationBundleLoadingException} for the specified
* bundle class and locale.
* Construct a
* {@link org.eclipse.jgit.errors.TranslationBundleLoadingException} for the
* specified bundle class and locale.
*
* @param bundleClass
* the bundle class for which the loading failed
@ -62,7 +62,8 @@ public class TranslationBundleLoadingException extends TranslationBundleExceptio
* the locale for which the loading failed
* @param cause
* the original exception thrown from the
* {@link ResourceBundle#getBundle(String, Locale)} method.
* {@link java.util.ResourceBundle#getBundle(String, Locale)}
* method.
*/
public TranslationBundleLoadingException(Class bundleClass, Locale locale, Exception cause) {
super("Loading of translation bundle failed for [" //$NON-NLS-1$

10
org.eclipse.jgit/src/org/eclipse/jgit/errors/TranslationStringMissingException.java
View File

@ -43,7 +43,6 @@
package org.eclipse.jgit.errors;
import java.util.Locale;
import java.util.ResourceBundle;
/**
* This exception will be thrown when a translation string for a translation
@ -55,8 +54,9 @@ public class TranslationStringMissingException extends TranslationBundleExceptio
private final String key;
/**
* Construct a {@link TranslationStringMissingException} for the specified
* bundle class, locale and translation key
* Construct a
* {@link org.eclipse.jgit.errors.TranslationStringMissingException} for the
* specified bundle class, locale and translation key
*
* @param bundleClass
* the bundle class for which a translation string was missing
@ -66,7 +66,7 @@ public class TranslationStringMissingException extends TranslationBundleExceptio
* the key of the missing translation string
* @param cause
* the original exception thrown from the
* {@link ResourceBundle#getString(String)} method.
* {@link java.util.ResourceBundle#getString(String)} method.
*/
public TranslationStringMissingException(Class bundleClass, Locale locale, String key, Exception cause) {
super("Translation missing for [" + bundleClass.getName() + ", " //$NON-NLS-1$ //$NON-NLS-2$
@ -76,6 +76,8 @@ public TranslationStringMissingException(Class bundleClass, Locale locale, Strin
}
/**
* Get the key of the missing translation string
*
* @return the key of the missing translation string
*/
public String getKey() {

6
org.eclipse.jgit/src/org/eclipse/jgit/errors/UnmergedPathException.java
View File

@ -68,7 +68,11 @@ public UnmergedPathException(final DirCacheEntry dce) {
entry = dce;
}
/** @return the first non-zero stage of the unmerged path */
/**
* Get the first non-zero stage of the unmerged path
*
* @return the first non-zero stage of the unmerged path
*/
public DirCacheEntry getDirCacheEntry() {
return entry;
}

4
org.eclipse.jgit/src/org/eclipse/jgit/errors/UnpackException.java
View File

@ -47,7 +47,9 @@
import org.eclipse.jgit.internal.JGitText;
/** Indicates a ReceivePack failure while scanning the pack stream. */
/**
* Indicates a ReceivePack failure while scanning the pack stream.
*/
public class UnpackException extends IOException {
private static final long serialVersionUID = 1L;

7
org.eclipse.jgit/src/org/eclipse/jgit/errors/UnsupportedCredentialItem.java
View File

@ -43,13 +43,12 @@
*/
package org.eclipse.jgit.errors;
import org.eclipse.jgit.transport.CredentialItem;
import org.eclipse.jgit.transport.CredentialsProvider;
import org.eclipse.jgit.transport.URIish;
/**
* An exception thrown when a {@link CredentialItem} is requested from a
* {@link CredentialsProvider} which is not supported by this provider.
* An exception thrown when a {@link org.eclipse.jgit.transport.CredentialItem}
* is requested from a {@link org.eclipse.jgit.transport.CredentialsProvider}
* which is not supported by this provider.
*/
public class UnsupportedCredentialItem extends RuntimeException {
private static final long serialVersionUID = 1L;