StarteamScmProvider (Maven SCM 1.10.0 API)

java.lang.Object
- org.apache.maven.scm.provider.AbstractScmProvider
- - org.apache.maven.scm.provider.starteam.StarteamScmProvider

All Implemented Interfaces:

ScmProvider
```
public class StarteamScmProvider
extends AbstractScmProvider
```
Author:

Trygve Laugstøl

Plexus component:
role:
"org.apache.maven.scm.provider.ScmProvider"
role-hint:
"starteam"

Field Summary

Fields
Modifier and Type Field and Description

static String STARTEAM_URL_FORMAT
- Fields inherited from interface org.apache.maven.scm.provider.ScmProvider
  ROLE

Fields
Modifier and Type	Field and Description
`static String`	`STARTEAM_URL_FORMAT`

Constructor Summary

Constructors
Constructor and Description

StarteamScmProvider()

Constructors
Constructor and Description
`StarteamScmProvider()`

Method Summary

Methods
Modifier and Type	Method and Description
`AddScmResult`	`add(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)`
`protected EditScmResult`	`edit(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)`
`static String`	`getRelativePath(File basedir, File f)`
`String`	`getScmType()`
`ScmProviderRepository`	`makeProviderScmRepository(String scmSpecificUrl, char delimiter)`
`RemoveScmResult`	`remove(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)`
`StatusScmResult`	`status(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)`
`TagScmResult`	`tag(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)`
`protected UnEditScmResult`	`unedit(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, addListener, 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, edit, export, export, export, export, export, export, getLogger, getScmSpecificFilename, info, list, list, list, login, makeProviderScmRepository, mkdir, mkdir, remoteInfo, remove, requiresEditMode, sanitizeTagName, status, tag, tag, tag, unedit, 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

Field Detail
- STARTEAM_URL_FORMAT
```
public static final String STARTEAM_URL_FORMAT
```
  See Also:
  Constant Field Values

Constructor Detail
- StarteamScmProvider
```
public StarteamScmProvider()
```

Method Detail

makeProviderScmRepository

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

Throws:: ScmRepositoryException

getScmType
```
public String getScmType()
```

add

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

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

diff

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

Overrides:: diff in class AbstractScmProvider
Throws:: ScmException

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

update

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

Overrides:: update in class AbstractScmProvider
Throws:: ScmException

edit

protected EditScmResult edit(ScmProviderRepository repository,
                 ScmFileSet fileSet,
                 CommandParameters parameters)
                      throws ScmException

Overrides:: edit in class AbstractScmProvider
Throws:: ScmException

unedit

protected UnEditScmResult unedit(ScmProviderRepository repository,
                     ScmFileSet fileSet,
                     CommandParameters parameters)
                          throws ScmException

Overrides:: unedit in class AbstractScmProvider
Throws:: ScmException

remove

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

Overrides:: remove in class AbstractScmProvider
Throws:: ScmException

getRelativePath

public static String getRelativePath(File basedir,
                     File f)
                              throws ScmException,
                                     IOException

Throws:: ScmException; IOException

Class StarteamScmProvider

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

STARTEAM_URL_FORMAT

Constructor Detail

StarteamScmProvider

Method Detail

makeProviderScmRepository

getScmType

add

changelog

checkin

checkout

diff

status

tag

update

edit

unedit

remove

getRelativePath