Package org.apache.maven.scm.provider.local

Class LocalScmProvider

java.lang.Object

org.apache.maven.scm.provider.AbstractScmProvider

org.apache.maven.scm.provider.local.LocalScmProvider

All Implemented Interfaces:

ScmProvider

@Singleton
@Named("local")
public class LocalScmProvider
extends AbstractScmProvider

Author:

Trygve Laugstøl, Emmanuel Venisse

Field Summary

Fields inherited from class org.apache.maven.scm.provider.AbstractScmProvider

logger

Constructor Summary

Constructors

Constructor	Description
LocalScmProvider()

Method Summary

Modifier and Type	Method	Description
AddScmResult	add(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)	TODO: why public? This should be protected, no?
protected ChangeLogScmResult	changelog(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
CheckInScmResult	checkin(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
CheckOutScmResult	checkout(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
static String	fixModuleName(String module)
String	getScmType()
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(String scmSpecificUrl, char delimiter)
protected MkdirScmResult	mkdir(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)	Create directory/directories in the repository.
StatusScmResult	status(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
TagScmResult	tag(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
UpdateScmResult	update(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)

Methods inherited from class org.apache.maven.scm.provider.AbstractScmProvider

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.maven.scm.provider.ScmProvider

setInteractive

Constructor Details

LocalScmProvider

public LocalScmProvider()

Method Details

getScmType

public String getScmType()

makeProviderScmRepository

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

Throws:

ScmRepositoryException

fixModuleName

public static String fixModuleName(String module)

status

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

Overrides:

status in class AbstractScmProvider

Throws:

ScmException

tag

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

Overrides:

tag in class AbstractScmProvider

Throws:

ScmException

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

protected 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

list

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

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:

NoSuchCommandScmException - unless overriden by subclass

ScmException - if any

mkdir

protected MkdirScmResult mkdir(ScmProviderRepository repository,
 ScmFileSet fileSet,
 CommandParameters parameters)
                        throws ScmException

Create directory/directories in the repository.

Overrides:

mkdir in class AbstractScmProvider

Parameters:

repository - TODO

fileSet - TODO

parameters - TODO

Returns:

TODO

Throws:

ScmException - if any

update

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

Overrides:

update in class AbstractScmProvider

Throws:

ScmException