From e0332bfbc61067c1d57f817e2a210d021e554044 Mon Sep 17 00:00:00 2001 From: Matthias Sohn Date: Sun, 17 Dec 2017 20:48:52 +0100 Subject: [PATCH] Fix javadoc in org.eclipse.jgit.lfs Change-Id: I97b53c083da6aa31719d9e10369030ee33dd23dc Signed-off-by: Matthias Sohn --- .../src/org/eclipse/jgit/lfs/CleanFilter.java | 18 ++++--- .../src/org/eclipse/jgit/lfs/Lfs.java | 18 +++++-- .../src/org/eclipse/jgit/lfs/LfsPointer.java | 17 +++++-- .../org/eclipse/jgit/lfs/SmudgeFilter.java | 11 ++++- .../errors/CorruptLongObjectException.java | 7 ++- .../jgit/lfs/errors/CorruptMediaFile.java | 14 ++++-- .../errors/InvalidLongObjectIdException.java | 2 + .../lfs/errors/LfsBandwidthLimitExceeded.java | 3 +- .../eclipse/jgit/lfs/errors/LfsException.java | 2 + .../lfs/errors/LfsInsufficientStorage.java | 3 +- .../jgit/lfs/errors/LfsRateLimitExceeded.java | 3 +- .../lfs/errors/LfsRepositoryNotFound.java | 3 +- .../lfs/errors/LfsRepositoryReadOnly.java | 2 + .../jgit/lfs/errors/LfsUnauthorized.java | 2 + .../jgit/lfs/errors/LfsUnavailable.java | 2 + .../jgit/lfs/errors/LfsValidationError.java | 2 + .../internal/AtomicObjectOutputStream.java | 26 +++++++--- .../eclipse/jgit/lfs/internal/LfsText.java | 2 + .../jgit/lfs/lib/AbbreviatedLongObjectId.java | 41 +++++++++++----- .../eclipse/jgit/lfs/lib/AnyLongObjectId.java | 47 +++++++++++-------- .../org/eclipse/jgit/lfs/lib/Constants.java | 4 +- .../jgit/lfs/lib/LfsPointerFilter.java | 7 ++- .../eclipse/jgit/lfs/lib/LongObjectId.java | 4 +- .../jgit/lfs/lib/MutableLongObjectId.java | 34 ++++++++------ 24 files changed, 190 insertions(+), 84 deletions(-) diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/CleanFilter.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/CleanFilter.java index 7b0e7ab4d9..cee456ca2d 100644 --- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/CleanFilter.java +++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/CleanFilter.java @@ -74,7 +74,8 @@ import org.eclipse.jgit.util.FileUtils; */ public class CleanFilter extends FilterCommand { /** - * The factory is responsible for creating instances of {@link CleanFilter} + * The factory is responsible for creating instances of + * {@link org.eclipse.jgit.lfs.CleanFilter} */ public final static FilterCommandFactory FACTORY = new FilterCommandFactory() { @@ -109,17 +110,19 @@ public class CleanFilter extends FilterCommand { private Path tmpFile; /** + * Constructor for CleanFilter. + * * @param db * the repository * @param in - * an {@link InputStream} providing the original content + * an {@link java.io.InputStream} providing the original content * @param out - * the {@link OutputStream} into which the content of the pointer - * file should be written. That's the content which will be added - * to the git repository - * @throws IOException + * the {@link java.io.OutputStream} into which the content of the + * pointer file should be written. That's the content which will + * be added to the git repository + * @throws java.io.IOException * when the creation of the temporary file fails or when no - * {@link OutputStream} for this file can be created + * {@link java.io.OutputStream} for this file can be created */ public CleanFilter(Repository db, InputStream in, OutputStream out) throws IOException { @@ -130,6 +133,7 @@ public class CleanFilter extends FilterCommand { this.aOut = new AtomicObjectOutputStream(tmpFile.toAbsolutePath()); } + /** {@inheritDoc} */ @Override public int run() throws IOException { try { diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/Lfs.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/Lfs.java index 75e34e0f63..7e6b99ed3f 100644 --- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/Lfs.java +++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/Lfs.java @@ -61,6 +61,8 @@ public class Lfs { private Path tmpDir; /** + * Constructor for Lfs. + * * @param root * the path to the LFS media directory. Will be "/.git/lfs" */ @@ -69,6 +71,8 @@ public class Lfs { } /** + * Get the LFS root directory + * * @return the path to the LFS directory */ public Path getLfsRoot() { @@ -76,8 +80,10 @@ public class Lfs { } /** - * @return the path to the temp directory used by LFS. Will be - * "/.git/lfs/tmp" + * Get the path to the temporary directory used by LFS. + * + * @return the path to the temporary directory used by LFS. Will be + * {@code /.git/lfs/tmp} */ public Path getLfsTmpDir() { if (tmpDir == null) { @@ -87,8 +93,10 @@ public class Lfs { } /** + * Get the object directory used by LFS + * * @return the path to the object directory used by LFS. Will be - * "/.git/lfs/objects" + * {@code /.git/lfs/objects} */ public Path getLfsObjDir() { if (objDir == null) { @@ -98,6 +106,8 @@ public class Lfs { } /** + * Get the media file which stores the original content + * * @param id * the id of the mediafile * @return the file which stores the original content. This will be files @@ -114,7 +124,7 @@ public class Lfs { * Create a new temp file in the LFS directory * * @return a new temporary file in the LFS directory - * @throws IOException + * @throws java.io.IOException * when the temp file could not be created */ public Path createTmpFile() throws IOException { diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/LfsPointer.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/LfsPointer.java index 56e7987443..360453116f 100644 --- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/LfsPointer.java +++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/LfsPointer.java @@ -88,6 +88,8 @@ public class LfsPointer { private long size; /** + *

Constructor for LfsPointer.

+ * * @param oid * the id of the content * @param size @@ -99,6 +101,8 @@ public class LfsPointer { } /** + *

Getter for the field oid.

+ * * @return the id of the content */ public AnyLongObjectId getOid() { @@ -106,6 +110,8 @@ public class LfsPointer { } /** + *

Getter for the field size.

+ * * @return the size of the content */ public long getSize() { @@ -116,7 +122,7 @@ public class LfsPointer { * Encode this object into the LFS format defined by {@link #VERSION} * * @param out - * the {@link OutputStream} into which the encoded data should be + * the {@link java.io.OutputStream} into which the encoded data should be * written */ public void encode(OutputStream out) { @@ -139,10 +145,10 @@ public class LfsPointer { * {@link #VERSION} * * @param in - * the {@link InputStream} from where to read the data - * @return an {@link LfsPointer} or null if the stream was not - * parseable as LfsPointer - * @throws IOException + * the {@link java.io.InputStream} from where to read the data + * @return an {@link org.eclipse.jgit.lfs.LfsPointer} or null + * if the stream was not parseable as LfsPointer + * @throws java.io.IOException */ @Nullable public static LfsPointer parseLfsPointer(InputStream in) @@ -173,6 +179,7 @@ public class LfsPointer { return null; } + /** {@inheritDoc} */ @Override public String toString() { return "LfsPointer: oid=" + oid.name() + ", size=" //$NON-NLS-1$ //$NON-NLS-2$ diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/SmudgeFilter.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/SmudgeFilter.java index 6b1f68d405..941edec1d8 100644 --- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/SmudgeFilter.java +++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/SmudgeFilter.java @@ -70,7 +70,8 @@ import org.eclipse.jgit.util.FileUtils; */ public class SmudgeFilter extends FilterCommand { /** - * The factory is responsible for creating instances of {@link SmudgeFilter} + * The factory is responsible for creating instances of + * {@link org.eclipse.jgit.lfs.SmudgeFilter} */ public final static FilterCommandFactory FACTORY = new FilterCommandFactory() { @Override @@ -93,10 +94,15 @@ public class SmudgeFilter extends FilterCommand { private Lfs lfs; /** + * Constructor for SmudgeFilter. + * * @param db + * a {@link org.eclipse.jgit.lib.Repository} object. * @param in + * a {@link java.io.InputStream} object. * @param out - * @throws IOException + * a {@link java.io.OutputStream} object. + * @throws java.io.IOException */ public SmudgeFilter(Repository db, InputStream in, OutputStream out) throws IOException { @@ -111,6 +117,7 @@ public class SmudgeFilter extends FilterCommand { } } + /** {@inheritDoc} */ @Override public int run() throws IOException { int b; diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/CorruptLongObjectException.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/CorruptLongObjectException.java index fea148b884..d45a0ee8c5 100644 --- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/CorruptLongObjectException.java +++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/CorruptLongObjectException.java @@ -66,8 +66,7 @@ public class CorruptLongObjectException extends IllegalArgumentException { * id of the long object * @param contentHash * hash of the long object's content - * - * @param message + * @param message a {@link java.lang.String} object. */ public CorruptLongObjectException(AnyLongObjectId id, AnyLongObjectId contentHash, @@ -78,6 +77,8 @@ public class CorruptLongObjectException extends IllegalArgumentException { } /** + * Get the id of the object. + * * @return the id of the object, i.e. the expected hash of the object's * content */ @@ -86,6 +87,8 @@ public class CorruptLongObjectException extends IllegalArgumentException { } /** + * Get the contentHash. + * * @return the actual hash of the object's content which doesn't match the * object's id when this exception is thrown which signals that the * object has been corrupted diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/CorruptMediaFile.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/CorruptMediaFile.java index f2b51c0442..08ef8074b2 100644 --- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/CorruptMediaFile.java +++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/CorruptMediaFile.java @@ -63,9 +63,11 @@ public class CorruptMediaFile extends IOException { private long size; /** - * @param mediaFile - * @param expectedSize - * @param size + *

Constructor for CorruptMediaFile.

+ * + * @param mediaFile a {@link java.nio.file.Path} object. + * @param expectedSize a long. + * @param size a long. */ @SuppressWarnings("boxing") public CorruptMediaFile(Path mediaFile, long expectedSize, @@ -78,6 +80,8 @@ public class CorruptMediaFile extends IOException { } /** + * Get the mediaFile. + * * @return the media file which seems to be corrupt */ public Path getMediaFile() { @@ -85,6 +89,8 @@ public class CorruptMediaFile extends IOException { } /** + * Get the expectedSize. + * * @return the expected size of the media file */ public long getExpectedSize() { @@ -92,6 +98,8 @@ public class CorruptMediaFile extends IOException { } /** + * Get the size. + * * @return the actual size of the media file in the file system */ public long getSize() { diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/InvalidLongObjectIdException.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/InvalidLongObjectIdException.java index ee33d905dc..f7bba858a8 100644 --- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/InvalidLongObjectIdException.java +++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/InvalidLongObjectIdException.java @@ -72,6 +72,8 @@ public class InvalidLongObjectIdException extends IllegalArgumentException { } /** + *

Constructor for InvalidLongObjectIdException.

+ * * @param idString * String containing the invalid id */ diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsBandwidthLimitExceeded.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsBandwidthLimitExceeded.java index 1b1baec13c..949981f4d4 100644 --- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsBandwidthLimitExceeded.java +++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsBandwidthLimitExceeded.java @@ -47,12 +47,13 @@ package org.eclipse.jgit.lfs.errors; * Thrown when the bandwidth limit for the user or repository has been exceeded. * * @since 4.5 - * */ public class LfsBandwidthLimitExceeded extends LfsException { private static final long serialVersionUID = 1L; /** + *

Constructor for LfsBandwidthLimitExceeded.

+ * * @param message * error message, which may be shown to an end-user. */ diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsException.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsException.java index 3b83639114..778a819d5f 100644 --- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsException.java +++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsException.java @@ -52,6 +52,8 @@ public class LfsException extends Exception { private static final long serialVersionUID = 1L; /** + *

Constructor for LfsException.

+ * * @param message * error message, which may be shown to an end-user. */ diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsInsufficientStorage.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsInsufficientStorage.java index 4faace9854..f8bb89cb78 100644 --- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsInsufficientStorage.java +++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsInsufficientStorage.java @@ -47,12 +47,13 @@ package org.eclipse.jgit.lfs.errors; * Thrown when there is insufficient storage on the server. * * @since 4.5 - * */ public class LfsInsufficientStorage extends LfsException { private static final long serialVersionUID = 1L; /** + *

Constructor for LfsInsufficientStorage.

+ * * @param message * error message, which may be shown to an end-user. */ diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsRateLimitExceeded.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsRateLimitExceeded.java index 6067830418..7f7ed9b16d 100644 --- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsRateLimitExceeded.java +++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsRateLimitExceeded.java @@ -47,12 +47,13 @@ package org.eclipse.jgit.lfs.errors; * Thrown when the user has hit a rate limit with the server. * * @since 4.5 - * */ public class LfsRateLimitExceeded extends LfsException { private static final long serialVersionUID = 1L; /** + *

Constructor for LfsRateLimitExceeded.

+ * * @param message * error message, which may be shown to an end-user. */ diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsRepositoryNotFound.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsRepositoryNotFound.java index 52c932a810..9fa11051af 100644 --- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsRepositoryNotFound.java +++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsRepositoryNotFound.java @@ -56,9 +56,10 @@ public class LfsRepositoryNotFound extends LfsException { private static final long serialVersionUID = 1L; /** + *

Constructor for LfsRepositoryNotFound.

+ * * @param name * the repository name. - * */ public LfsRepositoryNotFound(String name) { super(MessageFormat.format(LfsText.get().repositoryNotFound, name)); diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsRepositoryReadOnly.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsRepositoryReadOnly.java index 3610377a31..c3821fce03 100644 --- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsRepositoryReadOnly.java +++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsRepositoryReadOnly.java @@ -57,6 +57,8 @@ public class LfsRepositoryReadOnly extends LfsException { private static final long serialVersionUID = 1L; /** + *

Constructor for LfsRepositoryReadOnly.

+ * * @param name * the repository name. */ diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsUnauthorized.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsUnauthorized.java index 62b0cde4c9..45e29ec58e 100644 --- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsUnauthorized.java +++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsUnauthorized.java @@ -56,6 +56,8 @@ public class LfsUnauthorized extends LfsException { private static final long serialVersionUID = 1L; /** + *

Constructor for LfsUnauthorized.

+ * * @param operation * the operation that was attempted. * @param name diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsUnavailable.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsUnavailable.java index ecb5e9ee56..285a172b8f 100644 --- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsUnavailable.java +++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsUnavailable.java @@ -56,6 +56,8 @@ public class LfsUnavailable extends LfsException { private static final long serialVersionUID = 1L; /** + * Constructor for LfsUnavailable. + * * @param name * the repository name. */ diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsValidationError.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsValidationError.java index 5e445ecaa8..0492d3f1ab 100644 --- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsValidationError.java +++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/LfsValidationError.java @@ -53,6 +53,8 @@ public class LfsValidationError extends LfsException { private static final long serialVersionUID = 1L; /** + * Constructor for LfsValidationError. + * * @param message * error message, which may be shown to an end-user. */ diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/internal/AtomicObjectOutputStream.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/internal/AtomicObjectOutputStream.java index 1598b9e818..0762ac5f14 100644 --- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/internal/AtomicObjectOutputStream.java +++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/internal/AtomicObjectOutputStream.java @@ -56,9 +56,9 @@ import org.eclipse.jgit.lfs.lib.Constants; import org.eclipse.jgit.lfs.lib.LongObjectId; /** - * Output stream writing content to a {@link LockFile} which is committed on - * close(). The stream checks if the hash of the stream content matches the - * id. + * Output stream writing content to a + * {@link org.eclipse.jgit.internal.storage.file.LockFile} which is committed on + * close(). The stream checks if the hash of the stream content matches the id. */ public class AtomicObjectOutputStream extends OutputStream { @@ -71,9 +71,13 @@ public class AtomicObjectOutputStream extends OutputStream { private AnyLongObjectId id; /** + * Constructor for AtomicObjectOutputStream. + * * @param path + * a {@link java.nio.file.Path} object. * @param id - * @throws IOException + * a {@link org.eclipse.jgit.lfs.lib.AnyLongObjectId} object. + * @throws java.io.IOException */ public AtomicObjectOutputStream(Path path, AnyLongObjectId id) throws IOException { @@ -85,36 +89,46 @@ public class AtomicObjectOutputStream extends OutputStream { } /** + * Constructor for AtomicObjectOutputStream. + * * @param path - * @throws IOException + * a {@link java.nio.file.Path} object. + * @throws java.io.IOException */ public AtomicObjectOutputStream(Path path) throws IOException { this(path, null); } /** + * Get the id. + * * @return content hash of the object which was streamed through this - * stream. May return {@code null} if called before closing this stream. + * stream. May return {@code null} if called before closing this + * stream. */ public @Nullable AnyLongObjectId getId() { return id; } + /** {@inheritDoc} */ @Override public void write(int b) throws IOException { out.write(b); } + /** {@inheritDoc} */ @Override public void write(byte[] b) throws IOException { out.write(b); } + /** {@inheritDoc} */ @Override public void write(byte[] b, int off, int len) throws IOException { out.write(b, off, len); } + /** {@inheritDoc} */ @Override public void close() throws IOException { out.close(); diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/internal/LfsText.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/internal/LfsText.java index 44595887c4..ae5548c85c 100644 --- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/internal/LfsText.java +++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/internal/LfsText.java @@ -51,6 +51,8 @@ import org.eclipse.jgit.nls.TranslationBundle; public class LfsText extends TranslationBundle { /** + * Get an instance of this translation bundle. + * * @return an instance of this translation bundle */ public static LfsText get() { diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/AbbreviatedLongObjectId.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/AbbreviatedLongObjectId.java index e9eb0e3850..4529a25fc0 100644 --- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/AbbreviatedLongObjectId.java +++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/AbbreviatedLongObjectId.java @@ -48,14 +48,11 @@ import java.text.MessageFormat; import org.eclipse.jgit.lfs.errors.InvalidLongObjectIdException; import org.eclipse.jgit.lfs.internal.LfsText; -import org.eclipse.jgit.lib.AbbreviatedObjectId; -import org.eclipse.jgit.lib.AnyObjectId; -import org.eclipse.jgit.lib.ObjectId; import org.eclipse.jgit.util.NB; import org.eclipse.jgit.util.RawParseUtils; /** - * A prefix abbreviation of an {@link LongObjectId}. + * A prefix abbreviation of an {@link org.eclipse.jgit.lfs.lib.LongObjectId}. *

* Enable abbreviating SHA-256 strings used by Git LFS, using sufficient leading * digits from the LongObjectId name to still be unique within the repository @@ -65,7 +62,7 @@ import org.eclipse.jgit.util.RawParseUtils; * This class converts the hex string into a binary form, to make it more * efficient for matching against an object. * - * Ported to SHA-256 from {@link AbbreviatedObjectId} + * Ported to SHA-256 from {@link org.eclipse.jgit.lib.AbbreviatedObjectId} * * @since 4.3 */ @@ -117,13 +114,14 @@ public final class AbbreviatedLongObjectId implements Serializable { } /** - * Convert an AbbreviatedObjectId from an {@link AnyObjectId}. + * Convert an AbbreviatedObjectId from an + * {@link org.eclipse.jgit.lib.AnyObjectId}. *

* This method copies over all bits of the Id, and is therefore complete * (see {@link #isComplete()}). * * @param id - * the {@link ObjectId} to convert from. + * the {@link org.eclipse.jgit.lib.ObjectId} to convert from. * @return the converted object id. */ public static final AbbreviatedLongObjectId fromLongObjectId( @@ -213,17 +211,29 @@ public final class AbbreviatedLongObjectId implements Serializable { w4 = new_4; } - /** @return number of hex digits appearing in this id */ + /** + * Get length + * + * @return number of hex digits appearing in this id. + */ public int length() { return nibbles; } - /** @return true if this ObjectId is actually a complete id. */ + /** + * Check if this id is complete + * + * @return true if this ObjectId is actually a complete id. + */ public boolean isComplete() { return length() == Constants.LONG_OBJECT_ID_STRING_LENGTH; } - /** @return a complete ObjectId; null if {@link #isComplete()} is false */ + /** + * Convert to LongObjectId + * + * @return a complete ObjectId; null if {@link #isComplete()} is false. + */ public LongObjectId toLongObjectId() { return isComplete() ? new LongObjectId(w1, w2, w3, w4) : null; } @@ -321,7 +331,11 @@ public final class AbbreviatedLongObjectId implements Serializable { return NB.compareUInt64(w4, mask(4, bs[p + 3])); } - /** @return value for a fan-out style map, only valid of length >= 2. */ + /** + * Get the first byte of this id + * + * @return value for a fan-out style map, only valid of length >= 2. + */ public final int getFirstByte() { return (int) (w1 >>> 56); } @@ -330,11 +344,13 @@ public final class AbbreviatedLongObjectId implements Serializable { return mask(nibbles, word, v); } + /** {@inheritDoc} */ @Override public int hashCode() { return (int) (w1 >> 32); } + /** {@inheritDoc} */ @Override public boolean equals(final Object o) { if (o instanceof AbbreviatedLongObjectId) { @@ -346,6 +362,8 @@ public final class AbbreviatedLongObjectId implements Serializable { } /** + *

name.

+ * * @return string form of the abbreviation, in lower case hexadecimal. */ public final String name() { @@ -367,6 +385,7 @@ public final class AbbreviatedLongObjectId implements Serializable { return new String(b, 0, nibbles); } + /** {@inheritDoc} */ @SuppressWarnings("nls") @Override public String toString() { diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/AnyLongObjectId.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/AnyLongObjectId.java index caf034d933..96d6938529 100644 --- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/AnyLongObjectId.java +++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/AnyLongObjectId.java @@ -49,17 +49,17 @@ import java.io.Writer; import java.nio.ByteBuffer; import org.eclipse.jgit.lib.AnyObjectId; -import org.eclipse.jgit.lib.ObjectReader; import org.eclipse.jgit.util.NB; /** * A (possibly mutable) SHA-256 abstraction. *

- * If this is an instance of {@link MutableLongObjectId} the concept of equality + * If this is an instance of + * {@link org.eclipse.jgit.lfs.lib.MutableLongObjectId} the concept of equality * with this instance can alter at any time, if this instance is modified to * represent a different object name. * - * Ported to SHA-256 from {@link AnyObjectId} + * Ported to SHA-256 from {@link org.eclipse.jgit.lib.AnyObjectId} * * @since 4.3 */ @@ -132,14 +132,15 @@ public abstract class AnyLongObjectId implements Comparable { * @param index * index of the byte to obtain from the raw form of the * LongObjectId. Must be in range [0, - * {@link Constants#LONG_OBJECT_ID_LENGTH}). + * {@link org.eclipse.jgit.lfs.lib.Constants#LONG_OBJECT_ID_LENGTH}). * @return the value of the requested byte at {@code index}. Returned values * are unsigned and thus are in the range [0,255] rather than the * signed byte range of [-128, 127]. - * @throws ArrayIndexOutOfBoundsException + * @throws java.lang.ArrayIndexOutOfBoundsException * {@code index} is less than 0, equal to - * {@link Constants#LONG_OBJECT_ID_LENGTH}, or greater than - * {@link Constants#LONG_OBJECT_ID_LENGTH}. + * {@link org.eclipse.jgit.lfs.lib.Constants#LONG_OBJECT_ID_LENGTH}, + * or greater than + * {@link org.eclipse.jgit.lfs.lib.Constants#LONG_OBJECT_ID_LENGTH}. */ public final int getByte(int index) { long w; @@ -164,12 +165,9 @@ public abstract class AnyLongObjectId implements Comparable { } /** - * Compare this LongObjectId to another and obtain a sort ordering. + * {@inheritDoc} * - * @param other - * the other id to compare to. Must not be null. - * @return < 0 if this id comes before other; 0 if this id is equal to - * other; > 0 if this id comes after other. + * Compare this LongObjectId to another and obtain a sort ordering. */ @Override public final int compareTo(final AnyLongObjectId other) { @@ -263,6 +261,7 @@ public abstract class AnyLongObjectId implements Comparable { return abbr.prefixCompare(this) == 0; } + /** {@inheritDoc} */ @Override public final int hashCode() { return (int) (w1 >> 32); @@ -279,6 +278,7 @@ public abstract class AnyLongObjectId implements Comparable { return other != null ? equals(this, other) : false; } + /** {@inheritDoc} */ @Override public final boolean equals(final Object o) { if (o instanceof AnyLongObjectId) @@ -335,7 +335,7 @@ public abstract class AnyLongObjectId implements Comparable { * * @param w * the stream to write to. - * @throws IOException + * @throws java.io.IOException * the stream writing failed. */ public void copyRawTo(final OutputStream w) throws IOException { @@ -362,7 +362,7 @@ public abstract class AnyLongObjectId implements Comparable { * * @param w * the stream to copy to. - * @throws IOException + * @throws java.io.IOException * the stream writing failed. */ public void copyTo(final OutputStream w) throws IOException { @@ -421,7 +421,7 @@ public abstract class AnyLongObjectId implements Comparable { * * @param w * the stream to copy to. - * @throws IOException + * @throws java.io.IOException * the stream writing failed. */ public void copyTo(final Writer w) throws IOException { @@ -437,7 +437,7 @@ public abstract class AnyLongObjectId implements Comparable { * of object id (64 characters or larger). * @param w * the stream to copy to. - * @throws IOException + * @throws java.io.IOException * the stream writing failed. */ public void copyTo(final char[] tmp, final Writer w) throws IOException { @@ -486,6 +486,7 @@ public abstract class AnyLongObjectId implements Comparable { dst[o--] = '0'; } + /** {@inheritDoc} */ @SuppressWarnings("nls") @Override public String toString() { @@ -493,6 +494,8 @@ public abstract class AnyLongObjectId implements Comparable { } /** + * Get string form of the SHA-256 + * * @return string form of the SHA-256, in lower case hexadecimal. */ public final String name() { @@ -500,6 +503,8 @@ public abstract class AnyLongObjectId implements Comparable { } /** + * Get string form of the SHA-256 + * * @return string form of the SHA-256, in lower case hexadecimal. */ public final String getName() { @@ -510,8 +515,10 @@ public abstract class AnyLongObjectId implements Comparable { * Return an abbreviation (prefix) of this object SHA-256. *

* This implementation does not guarantee uniqueness. Callers should instead - * use {@link ObjectReader#abbreviate(AnyObjectId, int)} to obtain a unique - * abbreviation within the scope of a particular object database. + * use + * {@link org.eclipse.jgit.lib.ObjectReader#abbreviate(AnyObjectId, int)} to + * obtain a unique abbreviation within the scope of a particular object + * database. * * @param len * length of the abbreviated string. @@ -529,8 +536,8 @@ public abstract class AnyLongObjectId implements Comparable { * Obtain an immutable copy of this current object. *

* Only returns this if this instance is an unsubclassed - * instance of {@link LongObjectId}; otherwise a new instance is returned - * holding the same value. + * instance of {@link org.eclipse.jgit.lfs.lib.LongObjectId}; otherwise a + * new instance is returned holding the same value. *

* This method is useful to shed any additional memory that may be tied to * the subclass, yet retain the unique identity of the object id for future diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/Constants.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/Constants.java index 0220743724..6cec2bd37a 100644 --- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/Constants.java +++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/Constants.java @@ -52,7 +52,7 @@ import org.eclipse.jgit.lfs.internal.LfsText; * Misc. constants used throughout JGit LFS extension. * * @since 4.3 - **/ + */ @SuppressWarnings("nls") public final class Constants { /** @@ -111,7 +111,7 @@ public final class Constants { * Create a new digest function for objects. * * @return a new digest object. - * @throws RuntimeException + * @throws java.lang.RuntimeException * this Java virtual machine does not support the required hash * function. Very unlikely given that JGit uses a hash function * that is in the Java reference specification. diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/LfsPointerFilter.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/LfsPointerFilter.java index 6f672b88f0..dcc915d9fd 100644 --- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/LfsPointerFilter.java +++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/LfsPointerFilter.java @@ -66,12 +66,15 @@ public class LfsPointerFilter extends TreeFilter { private LfsPointer pointer; /** - * @return {@link LfsPointer} or {@code null} + * Get the field pointer. + * + * @return {@link org.eclipse.jgit.lfs.LfsPointer} or {@code null} */ public LfsPointer getPointer() { return pointer; } + /** {@inheritDoc} */ @Override public boolean include(TreeWalk walk) throws MissingObjectException, IncorrectObjectTypeException, IOException { @@ -91,11 +94,13 @@ public class LfsPointerFilter extends TreeFilter { } } + /** {@inheritDoc} */ @Override public boolean shouldBeRecursive() { return false; } + /** {@inheritDoc} */ @Override public TreeFilter clone() { return new LfsPointerFilter(); diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/LongObjectId.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/LongObjectId.java index c4a4e43b12..ec1e1791db 100644 --- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/LongObjectId.java +++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/LongObjectId.java @@ -49,14 +49,13 @@ import java.io.ObjectOutputStream; import java.io.Serializable; import org.eclipse.jgit.lfs.errors.InvalidLongObjectIdException; -import org.eclipse.jgit.lib.ObjectId; import org.eclipse.jgit.util.NB; import org.eclipse.jgit.util.RawParseUtils; /** * A SHA-256 abstraction. * - * Ported to SHA-256 from {@link ObjectId} + * Ported to SHA-256 from {@link org.eclipse.jgit.lib.ObjectId} * * @since 4.3 */ @@ -288,6 +287,7 @@ public class LongObjectId extends AnyLongObjectId implements Serializable { w4 = src.w4; } + /** {@inheritDoc} */ @Override public LongObjectId toObjectId() { return this; diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/MutableLongObjectId.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/MutableLongObjectId.java index 130e94ed0b..7b0c49444a 100644 --- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/MutableLongObjectId.java +++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/MutableLongObjectId.java @@ -47,14 +47,13 @@ import java.text.MessageFormat; import org.eclipse.jgit.lfs.errors.InvalidLongObjectIdException; import org.eclipse.jgit.lfs.internal.LfsText; -import org.eclipse.jgit.lib.MutableObjectId; import org.eclipse.jgit.util.NB; import org.eclipse.jgit.util.RawParseUtils; /** * A mutable SHA-256 abstraction. * - * Ported to SHA-256 from {@link MutableObjectId} + * Ported to SHA-256 from {@link org.eclipse.jgit.lib.MutableObjectId} * * @since 4.3 */ @@ -81,15 +80,17 @@ public class MutableLongObjectId extends AnyLongObjectId { * * @param index * index of the byte to set in the raw form of the ObjectId. Must - * be in range [0, {@link Constants#LONG_OBJECT_ID_LENGTH}). + * be in range [0, + * {@link org.eclipse.jgit.lfs.lib.Constants#LONG_OBJECT_ID_LENGTH}). * @param value * the value of the specified byte at {@code index}. Values are * unsigned and thus are in the range [0,255] rather than the * signed byte range of [-128, 127]. - * @throws ArrayIndexOutOfBoundsException + * @throws java.lang.ArrayIndexOutOfBoundsException * {@code index} is less than 0, equal to - * {@link Constants#LONG_OBJECT_ID_LENGTH}, or greater than - * {@link Constants#LONG_OBJECT_ID_LENGTH}. + * {@link org.eclipse.jgit.lfs.lib.Constants#LONG_OBJECT_ID_LENGTH}, + * or greater than + * {@link org.eclipse.jgit.lfs.lib.Constants#LONG_OBJECT_ID_LENGTH}. */ public void setByte(int index, int value) { switch (index >> 3) { @@ -135,7 +136,10 @@ public class MutableLongObjectId extends AnyLongObjectId { } } - /** Make this id match {@link LongObjectId#zeroId()}. */ + /** + * Make this id match + * {@link org.eclipse.jgit.lfs.lib.LongObjectId#zeroId()}. + */ public void clear() { w1 = 0; w2 = 0; @@ -144,7 +148,7 @@ public class MutableLongObjectId extends AnyLongObjectId { } /** - * Copy an LongObjectId into this mutable buffer. + * Copy a LongObjectId into this mutable buffer. * * @param src * the source id to copy from. @@ -157,7 +161,7 @@ public class MutableLongObjectId extends AnyLongObjectId { } /** - * Convert an LongObjectId from raw binary representation. + * Convert a LongObjectId from raw binary representation. * * @param bs * the raw byte buffer to read from. At least 32 bytes must be @@ -168,7 +172,7 @@ public class MutableLongObjectId extends AnyLongObjectId { } /** - * Convert an LongObjectId from raw binary representation. + * Convert a LongObjectId from raw binary representation. * * @param bs * the raw byte buffer to read from. At least 32 bytes after p @@ -184,7 +188,7 @@ public class MutableLongObjectId extends AnyLongObjectId { } /** - * Convert an LongObjectId from binary representation expressed in integers. + * Convert a LongObjectId from binary representation expressed in integers. * * @param longs * the raw long buffer to read from. At least 4 longs must be @@ -195,14 +199,13 @@ public class MutableLongObjectId extends AnyLongObjectId { } /** - * Convert an LongObjectId from binary representation expressed in longs. + * Convert a LongObjectId from binary representation expressed in longs. * * @param longs * the raw int buffer to read from. At least 4 longs after p must * be available within this longs array. * @param p * position to read the first integer of data from. - * */ public void fromRaw(final long[] longs, final int p) { w1 = longs[p]; @@ -212,7 +215,7 @@ public class MutableLongObjectId extends AnyLongObjectId { } /** - * Convert an LongObjectId from hex characters (US-ASCII). + * Convert a LongObjectId from hex characters (US-ASCII). * * @param buf * the US-ASCII buffer to read from. At least 32 bytes after @@ -225,7 +228,7 @@ public class MutableLongObjectId extends AnyLongObjectId { } /** - * Convert an LongObjectId from hex characters. + * Convert a LongObjectId from hex characters. * * @param str * the string to read from. Must be 64 characters long. @@ -249,6 +252,7 @@ public class MutableLongObjectId extends AnyLongObjectId { } } + /** {@inheritDoc} */ @Override public LongObjectId toObjectId() { return new LongObjectId(this); -- 2.39.5