org.apache.maven.plugins.release.helpers
Class ScmHelper

java.lang.Object
  extended by org.apache.maven.plugins.release.helpers.ScmHelper

public class ScmHelper
extends java.lang.Object

A bean for using the Maven SCM API.

Version:
$Id: ScmHelper.java 389781 2006-03-29 12:28:18Z evenisse $
Author:
Brett Porter, Emmanuel Venisse

Constructor Summary
ScmHelper()
           
 
Method Summary
 void add(java.lang.String file)
           
 void checkin(java.util.Collection pomFiles, java.lang.String message)
           
 void checkout()
           
 void edit(java.io.File file)
           
 java.io.File getCheckoutDirectory()
           
 java.lang.String getPassphrase()
           
 java.lang.String getPassword()
           
 java.lang.String getPrivateKey()
           
 java.lang.String getProvider()
           
 java.util.List getStatus()
           
 java.lang.String getTag()
           
 java.lang.String getTagBase()
           
 java.lang.String getUrl()
           
 java.lang.String getUsername()
           
 java.lang.String getWorkingDirectory()
           
 void remove(java.lang.String message, java.lang.String file)
           
 boolean requiresEditMode()
           
 void setPassphrase(java.lang.String passphrase)
           
 void setPassword(java.lang.String password)
           
 void setPrivateKey(java.lang.String privateKey)
           
 void setScmManager(org.apache.maven.scm.manager.ScmManager scmManager)
           
 void setTag(java.lang.String tag)
           
 void setTagBase(java.lang.String tagBase)
           
 void setUrl(java.lang.String url)
           
 void setUsername(java.lang.String username)
           
 void setWorkingDirectory(java.lang.String workingDirectory)
           
 void tag()
           
 void unedit(java.io.File file)
           
 void update()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ScmHelper

public ScmHelper()
Method Detail

getProvider

public java.lang.String getProvider()
                             throws org.apache.maven.scm.ScmException
Throws:
org.apache.maven.scm.ScmException

checkout

public void checkout()
              throws org.apache.maven.scm.ScmException,
                     java.io.IOException
Throws:
org.apache.maven.scm.ScmException
java.io.IOException

update

public void update()
            throws org.apache.maven.scm.ScmException
Throws:
org.apache.maven.scm.ScmException

getStatus

public java.util.List getStatus()
                         throws org.apache.maven.scm.ScmException
Throws:
org.apache.maven.scm.ScmException

add

public void add(java.lang.String file)
         throws org.apache.maven.scm.ScmException,
                java.io.IOException
Throws:
org.apache.maven.scm.ScmException
java.io.IOException

remove

public void remove(java.lang.String message,
                   java.lang.String file)
            throws org.apache.maven.scm.ScmException,
                   java.io.IOException
Throws:
org.apache.maven.scm.ScmException
java.io.IOException

checkin

public void checkin(java.util.Collection pomFiles,
                    java.lang.String message)
             throws org.apache.maven.scm.ScmException
Throws:
org.apache.maven.scm.ScmException

edit

public void edit(java.io.File file)
          throws org.apache.maven.scm.ScmException
Throws:
org.apache.maven.scm.ScmException

unedit

public void unedit(java.io.File file)
            throws org.apache.maven.scm.ScmException
Throws:
org.apache.maven.scm.ScmException

tag

public void tag()
         throws org.apache.maven.scm.ScmException
Throws:
org.apache.maven.scm.ScmException

setScmManager

public void setScmManager(org.apache.maven.scm.manager.ScmManager scmManager)

setUrl

public void setUrl(java.lang.String url)

getUrl

public java.lang.String getUrl()

setTag

public void setTag(java.lang.String tag)

getTag

public java.lang.String getTag()

setWorkingDirectory

public void setWorkingDirectory(java.lang.String workingDirectory)

getWorkingDirectory

public java.lang.String getWorkingDirectory()

getCheckoutDirectory

public java.io.File getCheckoutDirectory()

getTagBase

public java.lang.String getTagBase()

setTagBase

public void setTagBase(java.lang.String tagBase)

getUsername

public java.lang.String getUsername()

setUsername

public void setUsername(java.lang.String username)

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String password)

getPrivateKey

public java.lang.String getPrivateKey()

setPrivateKey

public void setPrivateKey(java.lang.String privateKey)

getPassphrase

public java.lang.String getPassphrase()

setPassphrase

public void setPassphrase(java.lang.String passphrase)

requiresEditMode

public boolean requiresEditMode()
                         throws org.apache.maven.scm.ScmException
Throws:
org.apache.maven.scm.ScmException


Copyright © 2002-2010 Apache Software Foundation. All Rights Reserved.