Author: evenisse
Date: Tue Apr 3 03:21:56 2007
New Revision: 525128
URL: http://svn.apache.org/viewvc?view=rev&rev=525128
Log:
[SCM-2] Add BasicScmManager
Added:
maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/manager/BasicScmManager.java
- copied unchanged from r524754,
maven/scm/trunk/maven-scm-api/src/test/java/org/apache/maven/scm/manager/BasicScmManager.java
Removed:
maven/scm/trunk/maven-scm-api/src/test/java/org/apache/maven/scm/manager/BasicScmManager.java
Modified:
maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/manager/ScmManager.java
maven/scm/trunk/maven-scm-site/src/site/apt/guide/usage.apt
Modified:
maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/manager/ScmManager.java
URL:
http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/manager/ScmManager.java?view=diff&rev=525128&r1=525127&r2=525128
==============================================================================
---
maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/manager/ScmManager.java
(original)
+++
maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/manager/ScmManager.java
Tue Apr 3 03:21:56 2007
@@ -42,12 +42,12 @@
// ----------------------------------------------------------------------
/**
- * Generate a SCMRepository from a SCM url
+ * Generate a SCMRepository from a SCM url.
*
* @param scmUrl the scm url
- * @return
- * @throws ScmRepositoryException
- * @throws NoSuchScmProviderException
+ * @return The scm repository
+ * @throws ScmRepositoryException if an error occurs in the scm
repository construction
+ * @throws NoSuchScmProviderException if the provider doesn't exist
*/
ScmRepository makeScmRepository( String scmUrl )
throws ScmRepositoryException, NoSuchScmProviderException;
@@ -56,7 +56,7 @@
throws ScmRepositoryException, UnknownRepositoryStructure,
NoSuchScmProviderException;
/**
- * Validate a SCM URL
+ * Validate a SCM URL.
*
* @param scmUrl the SCM URL to validate
* @return <code>List</code> of <code>String</code> objects with the
messages returned by the SCM provider
@@ -68,7 +68,7 @@
/**
* Returns the default provider registered for this providerType or a
specific implementation if the
- * 'maven.scm.provider.providerType.implementation' system proerty is
defined.
+ * 'maven.scm.provider.providerType.implementation' system property is
defined.
* For example: maven.scm.provider.cvs.implementation=cvs_native
*
* @param providerType The provider type (cvs, svn...)
Modified: maven/scm/trunk/maven-scm-site/src/site/apt/guide/usage.apt
URL:
http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-site/src/site/apt/guide/usage.apt?view=diff&rev=525128&r1=525127&r2=525128
==============================================================================
--- maven/scm/trunk/maven-scm-site/src/site/apt/guide/usage.apt (original)
+++ maven/scm/trunk/maven-scm-site/src/site/apt/guide/usage.apt Tue Apr 3
03:21:56 2007
@@ -17,13 +17,24 @@
minimal code.
+------------------------------------------+
- public ScmManager getScmManager()
+import org.apache.maven.scm.manager.ScmManager;
+
+public class MyApp
+{
+ private ScmManager scmManager;
+
+ public MyApp()
{
plexus = new Embedder();
plexus.start();
- return (ScmManager) plexus.lookup( ScmManager.ROLE );
+ scmManager = (ScmManager) plexus.lookup( ScmManager.ROLE );
+ }
+
+ public ScmManager getScmManager()
+ {
+ return scmManager;
}
+------------------------------------------+
@@ -31,7 +42,7 @@
** Without Plexus IOC
Without Plexus, you must add all your SCM providers in the manager and that
- will require more work. The first step is to create a new SCM manager class:
+ will require more work. You can use the basic SCM manager:
+------------------------------------------+
public class BasicScmManager
@@ -47,16 +58,25 @@
Now that your SCM Manager class is created, you can initialize it:
+------------------------------------------+
- public ScmManager getScmManager()
+import org.apache.maven.scm.manager.BasicScmManager;
+
+public class MyApp
+{
+ private ScmManager scmManager;
+
+ public MyApp()
{
- ScmManager manager = new BasicScmManager();
+ scmManager = new BasicScmManager();
//Add all SCM providers we want to use
- manager.addScmProvider( "cvs", new CvsJavaScmProvider() );
- manager.addScmProvider( "svn", new SvnExeScmProvider() );
+ scmManager.addScmProvider( "cvs", new CvsJavaScmProvider() );
+ scmManager.addScmProvider( "svn", new SvnExeScmProvider() );
...
+ }
- return manager;
+ public ScmManager getScmManager()
+ {
+ return scmManager;
}
+------------------------------------------+
