|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ScmProvider
Field Summary | |
---|---|
static String |
ROLE
|
Field Detail |
---|
static final String ROLE
Method Detail |
---|
String getScmType()
void addListener(ScmLogger logger)
logger
- The loggerboolean requiresEditMode()
ScmProviderRepository makeProviderScmRepository(String scmSpecificUrl, char delimiter) throws ScmRepositoryException
ScmRepositoryException
ScmProviderRepository makeProviderScmRepository(File path) throws ScmRepositoryException, UnknownRepositoryStructure
ScmRepositoryException
UnknownRepositoryStructure
List<String> validateScmUrl(String scmSpecificUrl, char delimiter)
scmSpecificUrl
- The SCM urldelimiter
- The delimiter used in the SCM url
String getScmSpecificFilename()
boolean validateTagName(String tag)
tag
- tag name to check
String sanitizeTagName(String tag)
tag
- input tag name
AddScmResult add(ScmRepository repository, ScmFileSet fileSet) throws ScmException
repository
- the source control systemfileSet
- the files to be added
AddScmResult
that contains the files that have been added
ScmException
- if anyAddScmResult add(ScmRepository repository, ScmFileSet fileSet, String message) throws ScmException
repository
- the source control systemfileSet
- the files to be addedmessage
- a string that is a comment on the new added file
AddScmResult
that contains the files that have been added
ScmException
- if anyAddScmResult add(ScmRepository repository, ScmFileSet fileSet, CommandParameters commandParameters) throws ScmException
repository
- the source control systemfileSet
- the files to be addedcommandParameters
- CommandParameters
AddScmResult
that contains the files that have been added
ScmException
- if anyBranchScmResult branch(ScmRepository repository, ScmFileSet fileSet, String branchName) throws ScmException
#branch(ScmRepository, ScmFileSet, String, String, ScmBranchParameters)
repository
- the source control systemfileSet
- the files to branch. Implementations can also give the changes
from the ScmFileSet.getBasedir()
downwards.branchName
- the branch name to apply to the files
ScmException
- if anyBranchScmResult branch(ScmRepository repository, ScmFileSet fileSet, String branchName, String message) throws ScmException
#branch(ScmRepository, ScmFileSet, String, String, ScmBranchParameters)
repository
- the source control systemfileSet
- the files to branch. Implementations can also give the changes
from the ScmFileSet.getBasedir()
downwards.branchName
- the branch name to apply to the filesmessage
- the commit message used for the tag creation
ScmException
- if anyBranchScmResult branch(ScmRepository repository, ScmFileSet fileSet, String branchName, ScmBranchParameters scmBranchParameters) throws ScmException
repository
- the source control systemfileSet
- the files to branch. Implementations can also give the changes from the
ScmFileSet.getBasedir()
downwards.branchName
- the branch name to apply to the files
ScmException
- if anyChangeLogScmResult changeLog(ScmRepository repository, ScmFileSet fileSet, Date startDate, Date endDate, int numDays, String branch) throws ScmException
changeLog(org.apache.maven.scm.repository.ScmRepository,
org.apache.maven.scm.ScmFileSet, java.util.Date, java.util.Date, int, org.apache.maven.scm.ScmBranch)
repository
- the source control systemfileSet
- the files to know the changes about. Implementations can also give the changes
from the ScmFileSet.getBasedir()
downwards.startDate
- the start date of the periodendDate
- the end date of the periodnumDays
- the number days before the current time if startdate and enddate are nullbranch
- the branch/tag name
ScmException
- if any@Deprecated ChangeLogScmResult changeLog(ScmRepository repository, ScmFileSet fileSet, Date startDate, Date endDate, int numDays, ScmBranch branch) throws ScmException
changeLog(org.apache.maven.scm.command.changelog.ChangeLogScmRequest)
instead
repository
- the source control systemfileSet
- the files to know the changes about. Implementations can also give the changes
from the ScmFileSet.getBasedir()
downwards.startDate
- the start date of the periodendDate
- the end date of the periodnumDays
- the number days before the current time if startdate and enddate are nullbranch
- the branch/tag
ScmException
- if any@Deprecated ChangeLogScmResult changeLog(ScmRepository repository, ScmFileSet fileSet, Date startDate, Date endDate, int numDays, String branch, String datePattern) throws ScmException
changeLog(org.apache.maven.scm.command.changelog.ChangeLogScmRequest)
instead
repository
- the source control systemfileSet
- the files to know the changes about. Implementations can also give the changes
from the ScmFileSet.getBasedir()
downwards.startDate
- the start date of the periodendDate
- the end date of the periodnumDays
- the number days before the current time if startdate and enddate are nullbranch
- the branch/tag namedatePattern
- the date pattern use in changelog output returned by scm tool
ScmException
- if anyChangeLogScmResult changeLog(ScmRepository repository, ScmFileSet fileSet, Date startDate, Date endDate, int numDays, ScmBranch branch, String datePattern) throws ScmException
changeLog(org.apache.maven.scm.command.changelog.ChangeLogScmRequest)
instead
repository
- the source control systemfileSet
- the files to know the changes about. Implementations can also give the changes
from the ScmFileSet.getBasedir()
downwards.startDate
- the start date of the periodendDate
- the end date of the periodnumDays
- the number days before the current time if startdate and enddate are nullbranch
- the branch/tagdatePattern
- the date pattern use in changelog output returned by scm tool
ScmException
- if anyChangeLogScmResult changeLog(ChangeLogScmRequest scmRequest) throws ScmException
scmRequest
- request wrapping detailed parameters for the changelog command
ScmException
- if any@Deprecated ChangeLogScmResult changeLog(ScmRepository repository, ScmFileSet fileSet, String startTag, String endTag) throws ScmException
changeLog(org.apache.maven.scm.command.changelog.ChangeLogScmRequest)
instead
repository
- the source control systemfileSet
- the files to know the changes about. Implementations can also give the changes
from the ScmFileSet.getBasedir()
downwards.startTag
- the start tagendTag
- the end tag
ScmException
- if any@Deprecated ChangeLogScmResult changeLog(ScmRepository repository, ScmFileSet fileSet, ScmVersion startVersion, ScmVersion endVersion) throws ScmException
changeLog(org.apache.maven.scm.command.changelog.ChangeLogScmRequest)
instead
repository
- the source control systemfileSet
- the files to know the changes about. Implementations can also give the changes
from the ScmFileSet.getBasedir()
downwards.startVersion
- the start branch/tag/revisionendVersion
- the end branch/tag/revision
ScmException
- if any@Deprecated ChangeLogScmResult changeLog(ScmRepository repository, ScmFileSet fileSet, String startTag, String endTag, String datePattern) throws ScmException
changeLog(org.apache.maven.scm.command.changelog.ChangeLogScmRequest)
instead
repository
- the source control systemfileSet
- the files to know the changes about. Implementations can also give the changes
from the ScmFileSet.getBasedir()
downwards.startTag
- the start tagendTag
- the end tagdatePattern
- the date pattern use in changelog output returned by scm tool
ScmException
- if any@Deprecated ChangeLogScmResult changeLog(ScmRepository repository, ScmFileSet fileSet, ScmVersion startRevision, ScmVersion endRevision, String datePattern) throws ScmException
changeLog(org.apache.maven.scm.command.changelog.ChangeLogScmRequest)
instead
repository
- the source control systemfileSet
- the files to know the changes about. Implementations can also give the changes
from the ScmFileSet.getBasedir()
downwards.startRevision
- the start revisionendRevision
- the end revisiondatePattern
- the date pattern use in changelog output returned by scm tool
ScmException
- if anyCheckInScmResult checkIn(ScmRepository repository, ScmFileSet fileSet, String tag, String message) throws ScmException
checkIn(org.apache.maven.scm.repository.ScmRepository,
org.apache.maven.scm.ScmFileSet, org.apache.maven.scm.ScmVersion, String)
repository
- the source control systemfileSet
- the files to check in (sometimes called commit)tag
- tag or revisionmessage
- a string that is a comment on the changes that where done
ScmException
- if anyCheckInScmResult checkIn(ScmRepository repository, ScmFileSet fileSet, String message) throws ScmException
repository
- the source control systemfileSet
- the files to check in (sometimes called commit)message
- a string that is a comment on the changes that where done
ScmException
- if anyCheckInScmResult checkIn(ScmRepository repository, ScmFileSet fileSet, ScmVersion revision, String message) throws ScmException
repository
- the source control systemfileSet
- the files to check in (sometimes called commit)revision
- branch/tag/revisionmessage
- a string that is a comment on the changes that where done
ScmException
- if anyCheckOutScmResult checkOut(ScmRepository repository, ScmFileSet fileSet, String tag) throws ScmException
checkOut(org.apache.maven.scm.repository.ScmRepository,
org.apache.maven.scm.ScmFileSet, org.apache.maven.scm.ScmVersion)
repository
- the source control systemfileSet
- the files are copied to the ScmFileSet.getBasedir()
locationtag
- get the version defined by the tag
ScmException
- if anyCheckOutScmResult checkOut(ScmRepository repository, ScmFileSet fileSet) throws ScmException
repository
- the source control systemfileSet
- the files are copied to the ScmFileSet.getBasedir()
location
ScmException
- if anyCheckOutScmResult checkOut(ScmRepository repository, ScmFileSet fileSet, ScmVersion version) throws ScmException
repository
- the source control systemfileSet
- the files are copied to the ScmFileSet.getBasedir()
locationversion
- get the version defined by the revision, branch or tag
ScmException
- if anyCheckOutScmResult checkOut(ScmRepository scmRepository, ScmFileSet scmFileSet, String tag, boolean recursive) throws ScmException
checkOut(org.apache.maven.scm.repository.ScmRepository,
org.apache.maven.scm.ScmFileSet, org.apache.maven.scm.ScmVersion, boolean)
scmRepository
- the source control systemscmFileSet
- the files are copied to the ScmFileSet.getBasedir()
locationtag
- tag or revisionrecursive
- whether to check out recursively
ScmException
- if anyCheckOutScmResult checkOut(ScmRepository scmRepository, ScmFileSet scmFileSet, boolean recursive) throws ScmException
scmRepository
- the source control systemscmFileSet
- the files are copied to the ScmFileSet.getBasedir()
locationrecursive
- whether to check out recursively
ScmException
- if anyCheckOutScmResult checkOut(ScmRepository scmRepository, ScmFileSet scmFileSet, ScmVersion version, boolean recursive) throws ScmException
scmRepository
- the source control systemscmFileSet
- the files are copied to the ScmFileSet.getBasedir()
locationversion
- get the version defined by the revision, branch or tagrecursive
- whether to check out recursively
ScmException
- if anyDiffScmResult diff(ScmRepository scmRepository, ScmFileSet scmFileSet, String startRevision, String endRevision) throws ScmException
diff(org.apache.maven.scm.repository.ScmRepository,
org.apache.maven.scm.ScmFileSet, org.apache.maven.scm.ScmVersion, org.apache.maven.scm.ScmVersion)
scmRepository
- the source control systemscmFileSet
- the files are copied to the ScmFileSet.getBasedir()
locationstartRevision
- the start revisionendRevision
- the end revision
ScmException
- if anyDiffScmResult diff(ScmRepository scmRepository, ScmFileSet scmFileSet, ScmVersion startVersion, ScmVersion endVersion) throws ScmException
scmRepository
- the source control systemscmFileSet
- the files are copied to the ScmFileSet.getBasedir()
locationstartVersion
- the start branch/tag/revisionendVersion
- the end branch/tag/revision
ScmException
- if anyExportScmResult export(ScmRepository repository, ScmFileSet fileSet, String tag) throws ScmException
export(org.apache.maven.scm.repository.ScmRepository,
org.apache.maven.scm.ScmFileSet, org.apache.maven.scm.ScmVersion)
repository
- the source control systemfileSet
- the files are copied to the ScmFileSet.getBasedir()
locationtag
- get the version defined by the tag
ScmException
- if anyExportScmResult export(ScmRepository repository, ScmFileSet fileSet) throws ScmException
repository
- the source control systemfileSet
- the files are copied to the ScmFileSet.getBasedir()
location
ScmException
- if anyExportScmResult export(ScmRepository repository, ScmFileSet fileSet, ScmVersion version) throws ScmException
repository
- the source control systemfileSet
- the files are copied to the ScmFileSet.getBasedir()
locationversion
- get the version defined by the branch/tag/revision
ScmException
- if anyExportScmResult export(ScmRepository repository, ScmFileSet fileSet, String tag, String outputDirectory) throws ScmException
export(org.apache.maven.scm.repository.ScmRepository,
org.apache.maven.scm.ScmFileSet, org.apache.maven.scm.ScmVersion, String)
repository
- the source control systemfileSet
- the files are copied to the ScmFileSet.getBasedir()
locationtag
- get the version defined by the tagoutputDirectory
- the directory where the export will be stored
ScmException
- if anyExportScmResult export(ScmRepository repository, ScmFileSet fileSet, ScmVersion version, String outputDirectory) throws ScmException
repository
- the source control systemfileSet
- the files are copied to the ScmFileSet.getBasedir()
locationversion
- get the version defined by the branch/tag/revisionoutputDirectory
- the directory where the export will be stored
ScmException
- if anyRemoveScmResult remove(ScmRepository repository, ScmFileSet fileSet, String message) throws ScmException
repository
- the source control systemfileSet
- the files to be removedmessage
-
ScmException
- if anyStatusScmResult status(ScmRepository repository, ScmFileSet fileSet) throws ScmException
ScmFileStatus
flags.
repository
- the source control systemfileSet
- the files to know the status about. Implementations can also give the changes
from the ScmFileSet.getBasedir()
downwards.
ScmException
- if anyTagScmResult tag(ScmRepository repository, ScmFileSet fileSet, String tagName) throws ScmException
tag(ScmRepository, ScmFileSet, String, ScmTagParameters)
repository
- the source control systemfileSet
- the files to tag. Implementations can also give the changes
from the ScmFileSet.getBasedir()
downwards.tagName
- the tag name to apply to the files
ScmException
- if anyTagScmResult tag(ScmRepository repository, ScmFileSet fileSet, String tagName, String message) throws ScmException
tag(ScmRepository, ScmFileSet, String, ScmTagParameters)
repository
- the source control systemfileSet
- the files to tag. Implementations can also give the changes
from the ScmFileSet.getBasedir()
downwards.tagName
- the tag name to apply to the filesmessage
- the commit message used for the tag creation
ScmException
- if anyTagScmResult tag(ScmRepository repository, ScmFileSet fileSet, String tagName, ScmTagParameters scmTagParameters) throws ScmException
repository
- the source control systemfileSet
- the files to tag. Implementations can also give the changes
from the ScmFileSet.getBasedir()
downwards.tagName
- the tag name to apply to the filesscmTagParameters
- bean to pass some paramters for tagging ScmTagParameters
ScmException
- if anyUpdateScmResult update(ScmRepository repository, ScmFileSet fileSet) throws ScmException
repository
- the source control systemfileSet
- location of your local copy
ScmException
- if anyUpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, String tag) throws ScmException
update(org.apache.maven.scm.repository.ScmRepository,
org.apache.maven.scm.ScmFileSet, org.apache.maven.scm.ScmVersion)
repository
- the source control systemfileSet
- location of your local copytag
- use the version defined by the tag
ScmException
- if anyUpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, ScmVersion version) throws ScmException
repository
- the source control systemfileSet
- location of your local copyversion
- use the version defined by the branch/tag/revision
ScmException
- if anyUpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, String tag, boolean runChangelog) throws ScmException
update(org.apache.maven.scm.repository.ScmRepository,
org.apache.maven.scm.ScmFileSet, org.apache.maven.scm.ScmVersion, boolean)
repository
- the source control systemfileSet
- location of your local copytag
- use the version defined by the tagrunChangelog
- Run the changelog command after the update
ScmException
- if anyUpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, boolean runChangelog) throws ScmException
repository
- the source control systemfileSet
- location of your local copyrunChangelog
- Run the changelog command after the update
ScmException
- if anyUpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, ScmVersion version, boolean runChangelog) throws ScmException
repository
- the source control systemfileSet
- location of your local copyversion
- use the version defined by the branch/tag/revisionrunChangelog
- Run the changelog command after the update
ScmException
- if anyUpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, String tag, String datePattern) throws ScmException
update(org.apache.maven.scm.repository.ScmRepository,
org.apache.maven.scm.ScmFileSet, org.apache.maven.scm.ScmVersion, String)
repository
- the source control systemfileSet
- location of your local copytag
- use the version defined by the tagdatePattern
- the date pattern use in changelog output returned by scm tool
ScmException
- if anyUpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, ScmVersion version, String datePattern) throws ScmException
repository
- the source control systemfileSet
- location of your local copyversion
- use the version defined by the branch/tag/revisiondatePattern
- the date pattern use in changelog output returned by scm tool
ScmException
- if anyUpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, String tag, Date lastUpdate) throws ScmException
update(org.apache.maven.scm.repository.ScmRepository,
org.apache.maven.scm.ScmFileSet, org.apache.maven.scm.ScmVersion, java.util.Date)
repository
- the source control systemfileSet
- location of your local copytag
- use the version defined by the taglastUpdate
-
ScmException
- if anyUpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, ScmVersion version, Date lastUpdate) throws ScmException
repository
- the source control systemfileSet
- location of your local copyversion
- use the version defined by the branch/tag/revisionlastUpdate
-
ScmException
- if anyUpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, String tag, Date lastUpdate, String datePattern) throws ScmException
update(org.apache.maven.scm.repository.ScmRepository,
org.apache.maven.scm.ScmFileSet, org.apache.maven.scm.ScmVersion, java.util.Date, String)
repository
- the source control systemfileSet
- location of your local copytag
- use the version defined by the taglastUpdate
- Date of last updatedatePattern
- the date pattern use in changelog output returned by scm tool
ScmException
- if anyUpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, ScmVersion version, Date lastUpdate, String datePattern) throws ScmException
repository
- the source control systemfileSet
- location of your local copyversion
- use the version defined by the branch/tag/revisionlastUpdate
- Date of last updatedatePattern
- the date pattern use in changelog output returned by scm tool
ScmException
- if anyEditScmResult edit(ScmRepository repository, ScmFileSet fileSet) throws ScmException
repository
- the source control systemfileSet
- the files to make editable
ScmException
- if anyUnEditScmResult unedit(ScmRepository repository, ScmFileSet fileSet) throws ScmException
edit(
org.apache.maven.scm.repository.ScmRepository, org.apache.maven.scm.ScmFileSet)
.
It makes the file read-only again.
repository
- the source control systemfileSet
- the files to make uneditable
ScmException
- if anyListScmResult list(ScmRepository repository, ScmFileSet fileSet, boolean recursive, String tag) throws ScmException
list(org.apache.maven.scm.repository.ScmRepository,
org.apache.maven.scm.ScmFileSet, boolean, org.apache.maven.scm.ScmVersion)
repository
- the source control systemfileSet
- the files to listrecursive
- descend recursivelytag
- use the version defined by the tag
ScmException
ListScmResult list(ScmRepository repository, ScmFileSet fileSet, boolean recursive, ScmVersion version) throws ScmException
repository
- the source control systemfileSet
- the files to listrecursive
- descend recursivelyversion
- use the version defined by the branch/tag/revision
ScmException
- if anyBlameScmResult blame(ScmRepository repository, ScmFileSet fileSet, String filename) throws ScmException
BlameScmRequest
parameter
repository
- the source control systemfileSet
- location of your local copyfilename
- file
ScmException
BlameScmResult blame(BlameScmRequest blameScmRequest) throws ScmException
blameScmRequest
-
ScmException
MkdirScmResult mkdir(ScmRepository repository, ScmFileSet fileSet, String message, boolean createInLocal) throws ScmException
repository
- fileSet
- createInLocal
- message
-
ScmException
InfoScmResult info(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException
repository
- the source control systemfileSet
- location of your local copyparameters
- some parameters (not use currently but for future use)
null
ScmException
RemoteInfoScmResult remoteInfo(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException
repository
- the source control systemfileSet
- not use currently but for future useparameters
- some parameters (not use currently but for future use)
null
ScmException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |