Skip to content

Commit ef9269b

Browse files
committed
unnecessary getWorkspace() removed
sinceCommit and untilCommit -> startRevision and endRevision documentation updated
1 parent 5b32613 commit ef9269b

File tree

2 files changed

+10
-13
lines changed

2 files changed

+10
-13
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -107,14 +107,14 @@ Note: null passed as a branch name is considered as Master Branch. Any non-null
107107
- Returns short name of current IVCS implementation: "git", "svn" etc
108108
- `VCSCommit removeFile(String branchName, String filePath, String commitMessage)`
109109
- Removes the file with path `filePath` within branch `branchName`. Operation is executed as separate commit with `commitMessage` message attached. Note: filePath = "folder\file.txt" -> file.txt is removed, folder is kept. Returns resulting commit.
110-
- `List<VCSCommit> getCommitsRange(String branchName, String firstCommitId, String untilCommitId)`
111-
- Returns ordered list of all commits located between commits specified by `firstCommitId` and `untilCommitId` inclusively within branch `branchName`
112-
- If `firstCommitId` is null then all commits until commit specified by `untilCommitId` inclusively are fetched
113-
- If `untilCommitId` is null then all commits starting from commit specified by `firstCommitId` are fetched
114-
- If `firstCommitId` and `untilCommitId` are null then all commits are fetched
115-
- `List<VCSCommit> getCommitsRange(String branchName, String firstCommitId, WalkDirection direction, int limit)`
116-
- Returns ordered list of `limit` commits (0 is unlimited) starting from commit specified by `firstCommitId` in direction specified by `direction`
117-
- If `firstCommitId` is null then commits are starting at branch `branchName` first commit (for ASC direction) or at head of branch (for DESC direction)
110+
- `List<VCSCommit> getCommitsRange(String branchName, String startRevision, String endRevision)`
111+
- Returns ordered list of all commits located between commits specified by `startRevision` and `endRevision` inclusively within branch `branchName`
112+
- If `startRevision` is null then all commits up to commit specified by `endRevision` inclusively are fetched
113+
- If `endRevision` is null then all commits starting from commit specified by `startRevision` are fetched
114+
- If `startRevision` and `endRevision` are null then all commits are fetched
115+
- `List<VCSCommit> getCommitsRange(String branchName, String startRevision, WalkDirection direction, int limit)`
116+
- Returns ordered list of `limit` commits (0 is unlimited) starting from commit specified by `startRevision` in direction specified by `direction`
117+
- If `startRevision` is null then all commits are fetched
118118
- `VCSCommit getHeadCommit(String branchName)`
119119
- Returns `VCSCommit` instance pointing to the head (last) commit of the branch `branchName` or `null` if the requested branch does not exists
120120
- `Boolean fileExists(String branchName, String filePath)`

src/main/java/org/scm4j/vcs/api/IVCS.java

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
import org.scm4j.vcs.api.exceptions.EVCSBranchExists;
44
import org.scm4j.vcs.api.exceptions.EVCSFileNotFound;
55
import org.scm4j.vcs.api.exceptions.EVCSTagExists;
6-
import org.scm4j.vcs.api.workingcopy.IVCSWorkspace;
76

87
import java.util.List;
98
import java.util.Set;
@@ -35,11 +34,9 @@ public interface IVCS {
3534

3635
VCSCommit removeFile(String branchName, String filePath, String commitMessage);
3736

38-
List<VCSCommit> getCommitsRange(String branchName, String firstCommitId, String untilCommitId);
37+
List<VCSCommit> getCommitsRange(String branchName, String startRevision, String endRevision);
3938

40-
List<VCSCommit> getCommitsRange(String branchName, String firstCommitId, WalkDirection direction, int limit);
41-
42-
IVCSWorkspace getWorkspace();
39+
List<VCSCommit> getCommitsRange(String branchName, String startRevision, WalkDirection direction, int limit);
4340

4441
VCSCommit getHeadCommit(String branchName);
4542

0 commit comments

Comments
 (0)