Class HgScmProvider

java.lang.Object

org.apache.maven.scm.provider.AbstractScmProvider

org.apache.maven.scm.provider.hg.HgScmProvider

All Implemented Interfaces:

ScmProvider

@Singleton
@Named("hg")
public class HgScmProvider
extends AbstractScmProvider

Mercurial (HG) is a decentralized revision control system.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	HgScmProvider.HgUrlParserResult

Field Summary

Fields inherited from class AbstractScmProvider

logger

Constructor Summary

Constructors

Constructor	Description
HgScmProvider()

Method Summary

Modifier and Type	Method	Description
AddScmResult	add(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)	TODO: why public? This should be protected, no?
protected BlameScmResult	blame(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
BranchScmResult	branch(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
ChangeLogScmResult	changelog(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
CheckInScmResult	checkin(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
CheckOutScmResult	checkout(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
DiffScmResult	diff(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
String	getScmSpecificFilename()	Returns the scm reserved file name where the SCM stores information like '.git', '.svn'.
String	getScmType()
InfoScmResult	info(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)	Returns result of hg id -i.
protected ListScmResult	list(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)	List each element (files and directories) of fileSet as they exist in the repository.
ScmProviderRepository	makeProviderScmRepository(File path)	Try to create a ScmProviderRepository for this provider from the given working directory (created through a previous checkout).
ScmProviderRepository	makeProviderScmRepository(String scmSpecificUrl, char delimiter)
private HgScmProvider.HgUrlParserResult	parseScmUrl(String scmSpecificUrl)
RemoveScmResult	remove(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
StatusScmResult	status(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
TagScmResult	tag(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
UpdateScmResult	update(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
List<String>	validateScmUrl(String scmSpecificUrl, char delimiter)	Validate the scm url.

Methods inherited from class AbstractScmProvider

add, add, add, blame, blame, branch, branch, branch, changeLog, changeLog, changeLog, changeLog, changeLog, changeLog, changeLog, changeLog, changeLog, checkIn, checkIn, checkIn, checkIn, checkOut, checkOut, checkOut, checkOut, checkOut, checkOut, checkOut, diff, diff, edit, edit, export, export, export, export, export, export, list, list, login, mkdir, mkdir, remoteInfo, remove, requiresEditMode, sanitizeTagName, status, tag, tag, tag, unedit, unedit, untag, update, update, update, update, update, update, update, update, update, update, update, update, validateTagName

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ScmProvider

setInteractive

Constructor Details

HgScmProvider

public HgScmProvider()

Method Details

getScmSpecificFilename

public String getScmSpecificFilename()

Returns the scm reserved file name where the SCM stores information like '.git', '.svn'.

Specified by:

getScmSpecificFilename in interface ScmProvider

Overrides:

getScmSpecificFilename in class AbstractScmProvider

Returns:

the scm reserved file name

makeProviderScmRepository

public ScmProviderRepository makeProviderScmRepository(String scmSpecificUrl,
 char delimiter)
                                                throws ScmRepositoryException

Throws:

ScmRepositoryException

parseScmUrl

private HgScmProvider.HgUrlParserResult parseScmUrl(String scmSpecificUrl)

makeProviderScmRepository

public ScmProviderRepository makeProviderScmRepository(File path)
                                                throws ScmRepositoryException,
UnknownRepositoryStructure

Try to create a ScmProviderRepository for this provider from the given working directory (created through a previous checkout). This is only successful if the working directory is recognized by this SCM provider.

Specified by:

makeProviderScmRepository in interface ScmProvider

Overrides:

makeProviderScmRepository in class AbstractScmProvider

Parameters:

path - the checkout(working) directory

Returns:

the repository bound to this provider

Throws:

ScmRepositoryException - in case the given directory does not contain a valid working directory recognized by this provider

UnknownRepositoryStructure - in case the provider does not support this way of initializing an ScmProviderRepository

validateScmUrl

public List<String> validateScmUrl(String scmSpecificUrl,
 char delimiter)

Validate the scm url.

Specified by:

validateScmUrl in interface ScmProvider

Overrides:

validateScmUrl in class AbstractScmProvider

Parameters:

scmSpecificUrl - the SCM url

delimiter - the delimiter used in the SCM url

Returns:

returns a list of messages if the validation failed

getScmType

public String getScmType()

add

public AddScmResult add(ScmProviderRepository repository,
 ScmFileSet fileSet,
 CommandParameters parameters)
                 throws ScmException

TODO: why public? This should be protected, no?

Overrides:

add in class AbstractScmProvider

Throws:

ScmException

changelog

public ChangeLogScmResult changelog(ScmProviderRepository repository,
 ScmFileSet fileSet,
 CommandParameters parameters)
                             throws ScmException

Overrides:

changelog in class AbstractScmProvider

Throws:

ScmException

checkin

public CheckInScmResult checkin(ScmProviderRepository repository,
 ScmFileSet fileSet,
 CommandParameters parameters)
                         throws ScmException

Overrides:

checkin in class AbstractScmProvider

Throws:

ScmException

checkout

public CheckOutScmResult checkout(ScmProviderRepository repository,
 ScmFileSet fileSet,
 CommandParameters parameters)
                           throws ScmException

Overrides:

checkout in class AbstractScmProvider

Throws:

ScmException

tag

public TagScmResult tag(ScmProviderRepository repository,
 ScmFileSet fileSet,
 CommandParameters parameters)
                 throws ScmException

Overrides:

tag in class AbstractScmProvider

Throws:

ScmException

diff

public DiffScmResult diff(ScmProviderRepository repository,
 ScmFileSet fileSet,
 CommandParameters parameters)
                   throws ScmException

Overrides:

diff in class AbstractScmProvider

Throws:

ScmException

remove

public RemoveScmResult remove(ScmProviderRepository repository,
 ScmFileSet fileSet,
 CommandParameters parameters)
                       throws ScmException

Overrides:

remove in class AbstractScmProvider

Throws:

ScmException

status

public StatusScmResult status(ScmProviderRepository repository,
 ScmFileSet fileSet,
 CommandParameters parameters)
                       throws ScmException

Overrides:

status in class AbstractScmProvider

Throws:

ScmException

update

public UpdateScmResult update(ScmProviderRepository repository,
 ScmFileSet fileSet,
 CommandParameters parameters)
                       throws ScmException

Overrides:

update in class AbstractScmProvider

Throws:

ScmException

blame

protected BlameScmResult blame(ScmProviderRepository repository,
 ScmFileSet fileSet,
 CommandParameters parameters)
                        throws ScmException

Overrides:

blame in class AbstractScmProvider

Throws:

ScmException

branch

public BranchScmResult branch(ScmProviderRepository repository,
 ScmFileSet fileSet,
 CommandParameters parameters)
                       throws ScmException

Overrides:

branch in class AbstractScmProvider

Throws:

ScmException

list

protected ListScmResult list(ScmProviderRepository repository,
 ScmFileSet fileSet,
 CommandParameters parameters)
                      throws ScmException

Description copied from class: AbstractScmProvider

List each element (files and directories) of fileSet as they exist in the repository.

Overrides:

list in class AbstractScmProvider

Parameters:

repository - the source control system

fileSet - the files to list

parameters - TODO

Returns:

the list of files in the repository

Throws:

ScmException - if any

Since:

1.5

info

public InfoScmResult info(ScmProviderRepository repository,
 ScmFileSet fileSet,
 CommandParameters parameters)
                   throws ScmException

Returns result of hg id -i.

Specified by:

info in interface ScmProvider

Overrides:

info in class AbstractScmProvider

Parameters:

repository - the source control system

fileSet - location of your local copy

parameters - some parameters (not use currently but for future use)

Returns:

if the scm implementation doesn't support "info" result will null

Throws:

ScmException - if any

Since:

1.5

See Also:

• AbstractScmProvider.info(org.apache.maven.scm.provider.ScmProviderRepository, org.apache.maven.scm.ScmFileSet, org.apache.maven.scm.CommandParameters)