[SCM-679] enhance scm api to support limited number of returned changesets by changelog command

• Type: New Feature
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.7, 1.8
• Fix Version/s: 1.8
• Component/s: maven-scm-api, maven-scm-provider-bazaar, maven-scm-provider-gitexe, maven-scm-provider-mercurial (hg), maven-scm-provider-svn
• Flags: Patch
• Assignee: Olivier Lamy
• Reporter: Petr Kozelka
• Created: 19/Jun/12 19:57
• Updated: 05/Apr/15 14:54
• Resolved: 22/Jun/12 03:37

Description

The current api returns changesets between specified/unspecified dates/revisions.
This leaves some important usecases unsupported; some of them are:

• get last changeset on given repository/path
• get last n changesets there ("first page" when browsing changes)

The only workarround currently possible is, list all commits and filter them - but this is very time consuming.
For this reason, I propose attached enhancement which overloads the changeLog method, adding the limit parameter:

    ChangeLogScmResult changeLog( ScmRepository repository, ScmFileSet fileSet, Date startDate, Date endDate,
                                  int numDays, ScmBranch branch, String datePattern, Integer limit )
        throws ScmException;

For the "last changeset" usecase, the client sets limit = 1.

For "paged browsing", it can specify null startDate/endDate on firstPage, and then work with dates for next/previous pages, still using the limit to specify page size.

Note that the limit parameter can be null (as it is "Integer", not "int") to specify unlimited number of returned changesets.

The suggested patch includes deprecations of enhanced methods, I hope this is a good way to reduce the number of actively used overloaded variants of "changelog" in future.