org.codehaus.mojo.scmchangelog.scm.util
Class DefaultScmAdapter

java.lang.Object
  org.codehaus.mojo.scmchangelog.scm.util.ScmAdapter
      org.codehaus.mojo.scmchangelog.scm.util.DefaultScmAdapter

public class DefaultScmAdapter
extends ScmAdapter

Empty Adapter to be used as a defaut scm adapter throwing UnsupportedOperationException.

Version:

$Id$

Author:

ehsavoie

Field Summary

Fields inherited from class org.codehaus.mojo.scmchangelog.scm.util.ScmAdapter

grammar, logger, manager

Constructor Summary

DefaultScmAdapter(org.apache.maven.scm.manager.ScmManager currentManager, GrammarEnum currentGrammar)
Constructor of ScmAdapter.

Method Summary

List	getListOfReleases(org.apache.maven.scm.repository.ScmRepository repository, org.apache.maven.scm.ScmFileSet fileSet) Returns the list of releases defined in a SCM repository.
org.apache.maven.scm.ScmVersion	getScmVersion(ScmTarget versionType, String version) Returns the Scm version.

Methods inherited from class org.codehaus.mojo.scmchangelog.scm.util.ScmAdapter

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultScmAdapter

public DefaultScmAdapter(org.apache.maven.scm.manager.ScmManager currentManager,
                         GrammarEnum currentGrammar)

Constructor of ScmAdapter.

Parameters:

currentManager - the ScmManager to access SCM elements.

currentGrammar - the grammar used to extract elements from the comments.

Method Detail

getListOfReleases

public List getListOfReleases(org.apache.maven.scm.repository.ScmRepository repository,
                              org.apache.maven.scm.ScmFileSet fileSet)
                       throws MojoExecutionException,
                              org.apache.maven.scm.ScmException

Returns the list of releases defined in a SCM repository.

Specified by:

getListOfReleases in class ScmAdapter

Parameters:

repository - the SCM repository.

fileSet - the base fileset.

Returns:

the list of releases defined in the SCM. List<Release>

Throws:

org.apache.maven.scm.ScmException - in case of an error with the SCM.

MojoExecutionException - in case of an error in executing the Mojo.

getScmVersion

public org.apache.maven.scm.ScmVersion getScmVersion(ScmTarget versionType,
                                                     String version)
                                              throws MojoExecutionException

Returns the Scm version.

Specified by:

getScmVersion in class ScmAdapter

Parameters:

versionType - the type of version (tag, trunk, branch).

version - the tag/branche name.

Returns:

the corresponding ScmVersion.

Throws:

MojoExecutionException - in case of an error in executing the Mojo.