Browse Source

Add missing @since tags to mark API added in 2.0

Change-Id: I0a86ce0e393dfde9bb27f0b29e036e76c856396e
Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>
Signed-off-by: Chris Aniszczyk <zx@twitter.com>
stable-2.0
Matthias Sohn 13 years ago committed by Chris Aniszczyk
parent
commit
c394d05a47
  1. 1
      org.eclipse.jgit/src/org/eclipse/jgit/api/ApplyCommand.java
  2. 2
      org.eclipse.jgit/src/org/eclipse/jgit/api/ApplyResult.java
  3. 1
      org.eclipse.jgit/src/org/eclipse/jgit/api/CheckoutCommand.java
  4. 4
      org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java
  5. 2
      org.eclipse.jgit/src/org/eclipse/jgit/api/RebaseResult.java
  6. 1
      org.eclipse.jgit/src/org/eclipse/jgit/api/StashCreateCommand.java
  7. 1
      org.eclipse.jgit/src/org/eclipse/jgit/api/StashDropCommand.java
  8. 1
      org.eclipse.jgit/src/org/eclipse/jgit/api/TagCommand.java
  9. 2
      org.eclipse.jgit/src/org/eclipse/jgit/diff/DiffFormatter.java
  10. 2
      org.eclipse.jgit/src/org/eclipse/jgit/dircache/InvalidPathException.java
  11. 1
      org.eclipse.jgit/src/org/eclipse/jgit/storage/dfs/InMemoryRepository.java
  12. 2
      org.eclipse.jgit/src/org/eclipse/jgit/storage/file/ReflogWriter.java
  13. 2
      org.eclipse.jgit/src/org/eclipse/jgit/transport/AbstractAdvertiseRefsHook.java
  14. 6
      org.eclipse.jgit/src/org/eclipse/jgit/transport/AdvertiseRefsHook.java
  15. 52
      org.eclipse.jgit/src/org/eclipse/jgit/transport/BasePackFetchConnection.java
  16. 20
      org.eclipse.jgit/src/org/eclipse/jgit/transport/BasePackPushConnection.java
  17. 7
      org.eclipse.jgit/src/org/eclipse/jgit/transport/ReceiveCommand.java
  18. 6
      org.eclipse.jgit/src/org/eclipse/jgit/transport/RequestNotYetReadException.java
  19. 6
      org.eclipse.jgit/src/org/eclipse/jgit/transport/ServiceMayNotContinueException.java
  20. 2
      org.eclipse.jgit/src/org/eclipse/jgit/transport/SideBandOutputStream.java
  21. 1
      org.eclipse.jgit/src/org/eclipse/jgit/treewalk/AbstractTreeIterator.java
  22. 1
      org.eclipse.jgit/src/org/eclipse/jgit/util/FileUtils.java
  23. 1
      org.eclipse.jgit/src/org/eclipse/jgit/util/IO.java
  24. 2
      org.eclipse.jgit/src/org/eclipse/jgit/util/StringUtils.java
  25. 1
      org.eclipse.jgit/src/org/eclipse/jgit/util/io/EolCanonicalizingInputStream.java

1
org.eclipse.jgit/src/org/eclipse/jgit/api/ApplyCommand.java

@ -68,6 +68,7 @@ import org.eclipse.jgit.util.IO;
* *
* @see <a href="http://www.kernel.org/pub/software/scm/git/docs/git-apply.html" * @see <a href="http://www.kernel.org/pub/software/scm/git/docs/git-apply.html"
* >Git documentation about apply</a> * >Git documentation about apply</a>
* @since 2.0
*/ */
public class ApplyCommand extends GitCommand<ApplyResult> { public class ApplyCommand extends GitCommand<ApplyResult> {

2
org.eclipse.jgit/src/org/eclipse/jgit/api/ApplyResult.java

@ -48,6 +48,8 @@ import java.util.List;
/** /**
* Encapsulates the result of a {@link ApplyCommand} * Encapsulates the result of a {@link ApplyCommand}
*
* @since 2.0
*/ */
public class ApplyResult { public class ApplyResult {

1
org.eclipse.jgit/src/org/eclipse/jgit/api/CheckoutCommand.java

@ -253,6 +253,7 @@ public class CheckoutCommand extends GitCommand<Ref> {
* @param all * @param all
* true to checkout all paths, false otherwise * true to checkout all paths, false otherwise
* @return {@code this} * @return {@code this}
* @since 2.0
*/ */
public CheckoutCommand setAllPaths(boolean all) { public CheckoutCommand setAllPaths(boolean all) {
checkoutAllPaths = all; checkoutAllPaths = all;

4
org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java

@ -576,6 +576,7 @@ public class Git {
* Returns a command object used to create a stashed commit * Returns a command object used to create a stashed commit
* *
* @return a {@link StashCreateCommand} * @return a {@link StashCreateCommand}
* @since 2.0
*/ */
public StashCreateCommand stashCreate() { public StashCreateCommand stashCreate() {
return new StashCreateCommand(repo); return new StashCreateCommand(repo);
@ -585,6 +586,7 @@ public class Git {
* Returns a command object used to apply a stashed commit * Returns a command object used to apply a stashed commit
* *
* @return a {@link StashApplyCommand} * @return a {@link StashApplyCommand}
* @since 2.0
*/ */
public StashApplyCommand stashApply() { public StashApplyCommand stashApply() {
return new StashApplyCommand(repo); return new StashApplyCommand(repo);
@ -594,6 +596,7 @@ public class Git {
* Returns a command object used to drop a stashed commit * Returns a command object used to drop a stashed commit
* *
* @return a {@link StashDropCommand} * @return a {@link StashDropCommand}
* @since 2.0
*/ */
public StashDropCommand stashDrop() { public StashDropCommand stashDrop() {
return new StashDropCommand(repo); return new StashDropCommand(repo);
@ -608,6 +611,7 @@ public class Git {
* *
* @return a {@link ApplyCommand} used to collect all optional parameters * @return a {@link ApplyCommand} used to collect all optional parameters
* and to finally execute the {@code apply} command * and to finally execute the {@code apply} command
* @since 2.0
*/ */
public ApplyCommand apply() { public ApplyCommand apply() {
return new ApplyCommand(repo); return new ApplyCommand(repo);

2
org.eclipse.jgit/src/org/eclipse/jgit/api/RebaseResult.java

@ -113,6 +113,8 @@ public class RebaseResult {
/** /**
* Continue with nothing left to commit (possibly want skip). * Continue with nothing left to commit (possibly want skip).
*
* @since 2.0
*/ */
NOTHING_TO_COMMIT { NOTHING_TO_COMMIT {
@Override @Override

1
org.eclipse.jgit/src/org/eclipse/jgit/api/StashCreateCommand.java

@ -85,6 +85,7 @@ import org.eclipse.jgit.treewalk.filter.SkipWorkTreeFilter;
* *
* @see <a href="http://www.kernel.org/pub/software/scm/git/docs/git-stash.html" * @see <a href="http://www.kernel.org/pub/software/scm/git/docs/git-stash.html"
* >Git documentation about Stash</a> * >Git documentation about Stash</a>
* @since 2.0
*/ */
public class StashCreateCommand extends GitCommand<RevCommit> { public class StashCreateCommand extends GitCommand<RevCommit> {

1
org.eclipse.jgit/src/org/eclipse/jgit/api/StashDropCommand.java

@ -69,6 +69,7 @@ import org.eclipse.jgit.util.FileUtils;
* *
* @see <a href="http://www.kernel.org/pub/software/scm/git/docs/git-stash.html" * @see <a href="http://www.kernel.org/pub/software/scm/git/docs/git-stash.html"
* >Git documentation about Stash</a> * >Git documentation about Stash</a>
* @since 2.0
*/ */
public class StashDropCommand extends GitCommand<ObjectId> { public class StashDropCommand extends GitCommand<ObjectId> {

1
org.eclipse.jgit/src/org/eclipse/jgit/api/TagCommand.java

@ -105,6 +105,7 @@ public class TagCommand extends GitCommand<Ref> {
* exception can be retrieved by calling * exception can be retrieved by calling
* {@link Exception#getCause()}. Expect only * {@link Exception#getCause()}. Expect only
* {@code IOException's} to be wrapped. * {@code IOException's} to be wrapped.
* @since 2.0
*/ */
public Ref call() throws JGitInternalException, public Ref call() throws JGitInternalException,
ConcurrentRefUpdateException, InvalidTagNameException, NoHeadException { ConcurrentRefUpdateException, InvalidTagNameException, NoHeadException {

2
org.eclipse.jgit/src/org/eclipse/jgit/diff/DiffFormatter.java

@ -278,6 +278,7 @@ public class DiffFormatter {
* Get the prefix applied in front of old file paths. * Get the prefix applied in front of old file paths.
* *
* @return the prefix * @return the prefix
* @since 2.0
*/ */
public String getOldPrefix() { public String getOldPrefix() {
return this.oldPrefix; return this.oldPrefix;
@ -300,6 +301,7 @@ public class DiffFormatter {
* Get the prefix applied in front of new file paths. * Get the prefix applied in front of new file paths.
* *
* @return the prefix * @return the prefix
* @since 2.0
*/ */
public String getNewPrefix() { public String getNewPrefix() {
return this.newPrefix; return this.newPrefix;

2
org.eclipse.jgit/src/org/eclipse/jgit/dircache/InvalidPathException.java vendored

@ -49,6 +49,8 @@ import org.eclipse.jgit.internal.JGitText;
/** /**
* Thrown when JGit detects and refuses to use an invalid path * Thrown when JGit detects and refuses to use an invalid path
*
* @since 2.0
*/ */
public class InvalidPathException extends IllegalArgumentException { public class InvalidPathException extends IllegalArgumentException {

1
org.eclipse.jgit/src/org/eclipse/jgit/storage/dfs/InMemoryRepository.java

@ -35,6 +35,7 @@ public class InMemoryRepository extends DfsRepository {
* *
* @param repoDesc * @param repoDesc
* description of the repository. * description of the repository.
* @since 2.0
*/ */
public InMemoryRepository(DfsRepositoryDescription repoDesc) { public InMemoryRepository(DfsRepositoryDescription repoDesc) {
super(new DfsRepositoryBuilder<DfsRepositoryBuilder, InMemoryRepository>() { super(new DfsRepositoryBuilder<DfsRepositoryBuilder, InMemoryRepository>() {

2
org.eclipse.jgit/src/org/eclipse/jgit/storage/file/ReflogWriter.java

@ -73,6 +73,8 @@ import org.eclipse.jgit.util.FileUtils;
/** /**
* Utility for writing reflog entries * Utility for writing reflog entries
*
* @since 2.0
*/ */
public class ReflogWriter { public class ReflogWriter {

2
org.eclipse.jgit/src/org/eclipse/jgit/transport/AbstractAdvertiseRefsHook.java

@ -53,6 +53,8 @@ import org.eclipse.jgit.revwalk.RevWalk;
/** /**
* Implementation of {@link AdvertiseRefsHook} that advertises the same refs for * Implementation of {@link AdvertiseRefsHook} that advertises the same refs for
* upload-pack and receive-pack. * upload-pack and receive-pack.
*
* @since 2.0
*/ */
public abstract class AbstractAdvertiseRefsHook implements AdvertiseRefsHook { public abstract class AbstractAdvertiseRefsHook implements AdvertiseRefsHook {
public void advertiseRefs(UploadPack uploadPack) public void advertiseRefs(UploadPack uploadPack)

6
org.eclipse.jgit/src/org/eclipse/jgit/transport/AdvertiseRefsHook.java

@ -42,7 +42,11 @@
package org.eclipse.jgit.transport; package org.eclipse.jgit.transport;
/** Hook to allow callers to take over advertising refs to the client. */ /**
* Hook to allow callers to take over advertising refs to the client.
*
* @since 2.0
*/
public interface AdvertiseRefsHook { public interface AdvertiseRefsHook {
/** /**
* A simple hook that advertises the default refs. * A simple hook that advertises the default refs.

52
org.eclipse.jgit/src/org/eclipse/jgit/transport/BasePackFetchConnection.java

@ -120,34 +120,64 @@ public abstract class BasePackFetchConnection extends BasePackConnection
*/ */
protected static final int MIN_CLIENT_BUFFER = 2 * 32 * 46 + 8; protected static final int MIN_CLIENT_BUFFER = 2 * 32 * 46 + 8;
/** Include tags if we are also including the referenced objects. */ /**
* Include tags if we are also including the referenced objects.
* @since 2.0
*/
public static final String OPTION_INCLUDE_TAG = "include-tag"; public static final String OPTION_INCLUDE_TAG = "include-tag";
/** Mutli-ACK support for improved negotiation. */ /**
* Mutli-ACK support for improved negotiation.
* @since 2.0
*/
public static final String OPTION_MULTI_ACK = "multi_ack"; public static final String OPTION_MULTI_ACK = "multi_ack";
/** Mutli-ACK detailed support for improved negotiation. */ /**
* Mutli-ACK detailed support for improved negotiation.
* @since 2.0
*/
public static final String OPTION_MULTI_ACK_DETAILED = "multi_ack_detailed"; public static final String OPTION_MULTI_ACK_DETAILED = "multi_ack_detailed";
/** The client supports packs with deltas but not their bases. */ /**
* The client supports packs with deltas but not their bases.
* @since 2.0
*/
public static final String OPTION_THIN_PACK = "thin-pack"; public static final String OPTION_THIN_PACK = "thin-pack";
/** The client supports using the side-band for progress messages. */ /**
* The client supports using the side-band for progress messages.
* @since 2.0
*/
public static final String OPTION_SIDE_BAND = "side-band"; public static final String OPTION_SIDE_BAND = "side-band";
/** The client supports using the 64K side-band for progress messages. */ /**
* The client supports using the 64K side-band for progress messages.
* @since 2.0
*/
public static final String OPTION_SIDE_BAND_64K = "side-band-64k"; public static final String OPTION_SIDE_BAND_64K = "side-band-64k";
/** The client supports packs with OFS deltas. */ /**
* The client supports packs with OFS deltas.
* @since 2.0
*/
public static final String OPTION_OFS_DELTA = "ofs-delta"; public static final String OPTION_OFS_DELTA = "ofs-delta";
/** The client supports shallow fetches. */ /**
* The client supports shallow fetches.
* @since 2.0
*/
public static final String OPTION_SHALLOW = "shallow"; public static final String OPTION_SHALLOW = "shallow";
/** The client does not want progress messages and will ignore them. */ /**
* The client does not want progress messages and will ignore them.
* @since 2.0
*/
public static final String OPTION_NO_PROGRESS = "no-progress"; public static final String OPTION_NO_PROGRESS = "no-progress";
/** The client supports receiving a pack before it has sent "done". */ /**
* The client supports receiving a pack before it has sent "done".
* @since 2.0
*/
public static final String OPTION_NO_DONE = "no-done"; public static final String OPTION_NO_DONE = "no-done";
static enum MultiAck { static enum MultiAck {
@ -695,6 +725,8 @@ public abstract class BasePackFetchConnection extends BasePackConnection
* Notification event delivered just before the pack is received from the * Notification event delivered just before the pack is received from the
* network. This event can be used by RPC such as {@link TransportHttp} to * network. This event can be used by RPC such as {@link TransportHttp} to
* disable its request magic and ensure the pack stream is read correctly. * disable its request magic and ensure the pack stream is read correctly.
*
* @since 2.0
*/ */
protected void onReceivePack() { protected void onReceivePack() {
// By default do nothing for TCP based protocols. // By default do nothing for TCP based protocols.

20
org.eclipse.jgit/src/org/eclipse/jgit/transport/BasePackPushConnection.java

@ -83,16 +83,28 @@ import org.eclipse.jgit.transport.RemoteRefUpdate.Status;
*/ */
public abstract class BasePackPushConnection extends BasePackConnection implements public abstract class BasePackPushConnection extends BasePackConnection implements
PushConnection { PushConnection {
/** The client expects a status report after the server processes the pack. */ /**
* The client expects a status report after the server processes the pack.
* @since 2.0
*/
public static final String CAPABILITY_REPORT_STATUS = "report-status"; public static final String CAPABILITY_REPORT_STATUS = "report-status";
/** The server supports deleting refs. */ /**
* The server supports deleting refs.
* @since 2.0
*/
public static final String CAPABILITY_DELETE_REFS = "delete-refs"; public static final String CAPABILITY_DELETE_REFS = "delete-refs";
/** The server supports packs with OFS deltas. */ /**
* The server supports packs with OFS deltas.
* @since 2.0
*/
public static final String CAPABILITY_OFS_DELTA = "ofs-delta"; public static final String CAPABILITY_OFS_DELTA = "ofs-delta";
/** The client supports using the 64K side-band for progress messages. */ /**
* The client supports using the 64K side-band for progress messages.
* @since 2.0
*/
public static final String CAPABILITY_SIDE_BAND_64K = "side-band-64k"; public static final String CAPABILITY_SIDE_BAND_64K = "side-band-64k";
private final boolean thinPack; private final boolean thinPack;

7
org.eclipse.jgit/src/org/eclipse/jgit/transport/ReceiveCommand.java

@ -129,8 +129,9 @@ public class ReceiveCommand {
* commands to filter. * commands to filter.
* @param want * @param want
* desired status to filter by. * desired status to filter by.
* @return a copy of the command list containing only those commands with the * @return a copy of the command list containing only those commands with
* desired status. * the desired status.
* @since 2.0
*/ */
public static List<ReceiveCommand> filter(List<ReceiveCommand> commands, public static List<ReceiveCommand> filter(List<ReceiveCommand> commands,
final Result want) { final Result want) {
@ -195,6 +196,7 @@ public class ReceiveCommand {
* name of the ref being affected. * name of the ref being affected.
* @param type * @param type
* type of the command. * type of the command.
* @since 2.0
*/ */
public ReceiveCommand(final ObjectId oldId, final ObjectId newId, public ReceiveCommand(final ObjectId oldId, final ObjectId newId,
final String name, final Type type) { final String name, final Type type) {
@ -269,6 +271,7 @@ public class ReceiveCommand {
* *
* @param rp * @param rp
* receive-pack session. * receive-pack session.
* @since 2.0
*/ */
public void execute(final ReceivePack rp) { public void execute(final ReceivePack rp) {
try { try {

6
org.eclipse.jgit/src/org/eclipse/jgit/transport/RequestNotYetReadException.java

@ -43,7 +43,11 @@
package org.eclipse.jgit.transport; package org.eclipse.jgit.transport;
/** Indicates that a client request has not yet been read from the wire. */ /**
* Indicates that a client request has not yet been read from the wire.
*
* @since 2.0
*/
public class RequestNotYetReadException extends IllegalStateException { public class RequestNotYetReadException extends IllegalStateException {
private static final long serialVersionUID = 1L; private static final long serialVersionUID = 1L;

6
org.eclipse.jgit/src/org/eclipse/jgit/transport/ServiceMayNotContinueException.java

@ -45,7 +45,11 @@ package org.eclipse.jgit.transport;
import java.io.IOException; import java.io.IOException;
/** Indicates a transport service may not continue execution. */ /**
* Indicates a transport service may not continue execution.
*
* @since 2.0
*/
public class ServiceMayNotContinueException extends IOException { public class ServiceMayNotContinueException extends IOException {
private static final long serialVersionUID = 1L; private static final long serialVersionUID = 1L;

2
org.eclipse.jgit/src/org/eclipse/jgit/transport/SideBandOutputStream.java

@ -54,6 +54,8 @@ import org.eclipse.jgit.internal.JGitText;
* <p> * <p>
* This stream is buffered at packet sizes, so the caller doesn't need to wrap * This stream is buffered at packet sizes, so the caller doesn't need to wrap
* it in yet another buffered stream. * it in yet another buffered stream.
*
* @since 2.0
*/ */
public class SideBandOutputStream extends OutputStream { public class SideBandOutputStream extends OutputStream {
/** Channel used for pack data. */ /** Channel used for pack data. */

1
org.eclipse.jgit/src/org/eclipse/jgit/treewalk/AbstractTreeIterator.java

@ -651,6 +651,7 @@ public abstract class AbstractTreeIterator {
* JGit internal API for use by {@link DirCacheCheckout} * JGit internal API for use by {@link DirCacheCheckout}
* *
* @return start of name component part within {@link #getEntryPathBuffer()} * @return start of name component part within {@link #getEntryPathBuffer()}
* @since 2.0
*/ */
public int getNameOffset() { public int getNameOffset() {
return pathOffset; return pathOffset;

1
org.eclipse.jgit/src/org/eclipse/jgit/util/FileUtils.java

@ -79,6 +79,7 @@ public class FileUtils {
/** /**
* Option not to throw exceptions when a deletion finally doesn't succeed. * Option not to throw exceptions when a deletion finally doesn't succeed.
* @since 2.0
*/ */
public static final int IGNORE_ERRORS = 8; public static final int IGNORE_ERRORS = 8;

1
org.eclipse.jgit/src/org/eclipse/jgit/util/IO.java

@ -339,6 +339,7 @@ public class IO {
* @param s * @param s
* the string to read * the string to read
* @return the string divided into lines * @return the string divided into lines
* @since 2.0
*/ */
public static List<String> readLines(final String s) { public static List<String> readLines(final String s) {
List<String> l = new ArrayList<String>(); List<String> l = new ArrayList<String>();

2
org.eclipse.jgit/src/org/eclipse/jgit/util/StringUtils.java

@ -132,6 +132,7 @@ public final class StringUtils {
* second string to compare. * second string to compare.
* @return negative, zero or positive if a sorts before, is equal to, or * @return negative, zero or positive if a sorts before, is equal to, or
* sorts after b. * sorts after b.
* @since 2.0
*/ */
public static int compareIgnoreCase(String a, String b) { public static int compareIgnoreCase(String a, String b) {
for (int i = 0; i < a.length() && i < b.length(); i++) { for (int i = 0; i < a.length() && i < b.length(); i++) {
@ -154,6 +155,7 @@ public final class StringUtils {
* second string to compare. * second string to compare.
* @return negative, zero or positive if a sorts before, is equal to, or * @return negative, zero or positive if a sorts before, is equal to, or
* sorts after b. * sorts after b.
* @since 2.0
*/ */
public static int compareWithCase(String a, String b) { public static int compareWithCase(String a, String b) {
for (int i = 0; i < a.length() && i < b.length(); i++) { for (int i = 0; i < a.length() && i < b.length(); i++) {

1
org.eclipse.jgit/src/org/eclipse/jgit/util/io/EolCanonicalizingInputStream.java

@ -77,6 +77,7 @@ public class EolCanonicalizingInputStream extends InputStream {
* raw input stream * raw input stream
* @param detectBinary * @param detectBinary
* whether binaries should be detected * whether binaries should be detected
* @since 2.0
*/ */
public EolCanonicalizingInputStream(InputStream in, boolean detectBinary) { public EolCanonicalizingInputStream(InputStream in, boolean detectBinary) {
this.in = in; this.in = in;

Loading…
Cancel
Save