You are viewing a plain text version of this content. The canonical link for it is here.
Posted to scm-commits@maven.apache.org by vs...@apache.org on 2008/08/15 14:13:30 UTC

svn commit: r686197 - in /maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm: command/changelog/ command/list/ command/tag/ command/unlock/ manager/ provider/

Author: vsiveton
Date: Fri Aug 15 05:13:29 2008
New Revision: 686197

URL: http://svn.apache.org/viewvc?rev=686197&view=rev
Log:
o fixed checkstyle

Modified:
    maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/command/changelog/AbstractChangeLogCommand.java
    maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/command/list/ListScmResult.java
    maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/command/tag/AbstractTagCommand.java
    maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/command/unlock/AbstractUnlockCommand.java
    maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/manager/ScmManager.java
    maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/provider/AbstractScmProvider.java
    maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProvider.java
    maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmUrlUtils.java

Modified: maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/command/changelog/AbstractChangeLogCommand.java
URL: http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/command/changelog/AbstractChangeLogCommand.java?rev=686197&r1=686196&r2=686197&view=diff
==============================================================================
--- maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/command/changelog/AbstractChangeLogCommand.java (original)
+++ maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/command/changelog/AbstractChangeLogCommand.java Fri Aug 15 05:13:29 2008
@@ -90,9 +90,10 @@
 
             if ( numDays > 0 )
             {
-                startDate = new Date( System.currentTimeMillis() - (long) numDays * 24 * 60 * 60 * 1000 );
+                int day = 24 * 60 * 60 * 1000;
+                startDate = new Date( System.currentTimeMillis() - (long) numDays * day );
 
-                endDate = new Date( System.currentTimeMillis() + (long) 1 * 24 * 60 * 60 * 1000 );
+                endDate = new Date( System.currentTimeMillis() + (long) day );
             }
             else if ( endDate == null )
             {

Modified: maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/command/list/ListScmResult.java
URL: http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/command/list/ListScmResult.java?rev=686197&r1=686196&r2=686197&view=diff
==============================================================================
--- maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/command/list/ListScmResult.java (original)
+++ maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/command/list/ListScmResult.java Fri Aug 15 05:13:29 2008
@@ -20,13 +20,13 @@
  */
 
 import org.apache.maven.scm.ScmResult;
-import org.apache.maven.scm.provider.ScmProvider;
 
 import java.util.ArrayList;
 import java.util.List;
 
 /**
- * Result of {@link ScmProvider#list} operation
+ * Result of {@link org.apache.maven.scm.provider.ScmProvider#list(org.apache.maven.scm.repository.ScmRepository,
+ * org.apache.maven.scm.ScmFileSet, boolean, org.apache.maven.scm.ScmVersion)} operation
  *
  * @author <a href="mailto:carlos@apache.org">Carlos Sanchez</a>
  * @version $Id$

Modified: maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/command/tag/AbstractTagCommand.java
URL: http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/command/tag/AbstractTagCommand.java?rev=686197&r1=686196&r2=686197&view=diff
==============================================================================
--- maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/command/tag/AbstractTagCommand.java (original)
+++ maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/command/tag/AbstractTagCommand.java Fri Aug 15 05:13:29 2008
@@ -46,7 +46,7 @@
     {
         String tagName = parameters.getString( CommandParameter.TAG_NAME );
 
-        String message = parameters.getString( CommandParameter.MESSAGE, "[maven-scm] copy for tag " + tagName);
+        String message = parameters.getString( CommandParameter.MESSAGE, "[maven-scm] copy for tag " + tagName );
 
         return executeTagCommand( repository, fileSet, tagName, message );
     }

Modified: maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/command/unlock/AbstractUnlockCommand.java
URL: http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/command/unlock/AbstractUnlockCommand.java?rev=686197&r1=686196&r2=686197&view=diff
==============================================================================
--- maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/command/unlock/AbstractUnlockCommand.java (original)
+++ maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/command/unlock/AbstractUnlockCommand.java Fri Aug 15 05:13:29 2008
@@ -38,7 +38,6 @@
     protected abstract ScmResult executeUnlockCommand( ScmProviderRepository repository, File workingDirectory )
         throws ScmException;
 
-    /** {@inheritDoc} */
     public ScmResult executeCommand( ScmProviderRepository repository, File workingDirectory,
                                      CommandParameters parameters )
         throws ScmException

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?rev=686197&r1=686196&r2=686197&view=diff
==============================================================================
--- 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 Fri Aug 15 05:13:29 2008
@@ -113,7 +113,8 @@
      * Set the provider implementation
      *
      * @param providerType           The provider type, eg. <code>cvs</code>
-     * @param providerImplementation The provider implementation (the role-hint of the provider), eg. <code>cvs</code>, <code>cvs_native</code>
+     * @param providerImplementation The provider implementation (the role-hint of the provider),
+     * eg. <code>cvs</code>, <code>cvs_native</code>
      */
     void setScmProviderImplementation( String providerType, String providerImplementation );
 
@@ -136,7 +137,7 @@
      * @param fileSet    the files to be added
      * @param message    a string that is a comment on the new added file
      * @return an {@link AddScmResult} that contains the files that have been added
-     * @throws ScmException
+     * @throws ScmException if any
      */
     AddScmResult add( ScmRepository repository, ScmFileSet fileSet, String message )
         throws ScmException;
@@ -149,7 +150,7 @@
      *                   from the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} downwards.
      * @param branchName the branch name to apply to the files
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     BranchScmResult branch( ScmRepository repository, ScmFileSet fileSet, String branchName )
         throws ScmException;
@@ -163,7 +164,7 @@
      * @param branchName the branch name to apply to the files
      * @param message    the commit message used for the tag creation
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     BranchScmResult branch( ScmRepository repository, ScmFileSet fileSet, String branchName, String message )
         throws ScmException;
@@ -180,7 +181,7 @@
      * @param numDays    the number days before the current time if startdate and enddate are null
      * @param branch     the branch/tag
      * @return The SCM result of the changelog command
-     * @throws ScmException
+     * @throws ScmException if any
      */
     ChangeLogScmResult changeLog( ScmRepository repository, ScmFileSet fileSet, Date startDate, Date endDate,
                                   int numDays, ScmBranch branch )
@@ -199,7 +200,7 @@
      * @param branch      the branch/tag
      * @param datePattern the date pattern use in changelog output returned by scm tool
      * @return The SCM result of the changelog command
-     * @throws ScmException
+     * @throws ScmException if any
      */
     ChangeLogScmResult changeLog( ScmRepository repository, ScmFileSet fileSet, Date startDate, Date endDate,
                                   int numDays, ScmBranch branch, String datePattern )
@@ -215,7 +216,7 @@
      * @param startVersion the start branch/tag/revision
      * @param endVersion   the end branch/tag/revision
      * @return The SCM result of the changelog command
-     * @throws ScmException
+     * @throws ScmException if any
      */
     ChangeLogScmResult changeLog( ScmRepository repository, ScmFileSet fileSet, ScmVersion startVersion,
                                   ScmVersion endVersion )
@@ -232,7 +233,7 @@
      * @param endRevision   the end revision
      * @param datePattern   the date pattern use in changelog output returned by scm tool
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     ChangeLogScmResult changeLog( ScmRepository repository, ScmFileSet fileSet, ScmVersion startRevision,
                                   ScmVersion endRevision, String datePattern )
@@ -250,7 +251,7 @@
      * @param fileSet    the files to check in (sometimes called commit)
      * @param message    a string that is a comment on the changes that where done
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     CheckInScmResult checkIn( ScmRepository repository, ScmFileSet fileSet, String message )
         throws ScmException;
@@ -268,7 +269,7 @@
      * @param revision   branch/tag/revision
      * @param message    a string that is a comment on the changes that where done
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     CheckInScmResult checkIn( ScmRepository repository, ScmFileSet fileSet, ScmVersion revision, String message )
         throws ScmException;
@@ -279,7 +280,7 @@
      * @param repository the source control system
      * @param fileSet    the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     CheckOutScmResult checkOut( ScmRepository repository, ScmFileSet fileSet )
         throws ScmException;
@@ -291,7 +292,7 @@
      * @param fileSet    the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
      * @param version    get the version defined by the revision, branch or tag
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     CheckOutScmResult checkOut( ScmRepository repository, ScmFileSet fileSet, ScmVersion version )
         throws ScmException;
@@ -303,7 +304,7 @@
      * @param scmFileSet    the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
      * @param recursive     whether to check out recursively
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     CheckOutScmResult checkOut( ScmRepository scmRepository, ScmFileSet scmFileSet, boolean recursive )
         throws ScmException;
@@ -316,7 +317,7 @@
      * @param version       get the version defined by the revision, branch or tag
      * @param recursive     whether to check out recursively
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     CheckOutScmResult checkOut( ScmRepository scmRepository, ScmFileSet scmFileSet, ScmVersion version,
                                 boolean recursive )
@@ -330,7 +331,7 @@
      * @param startVersion  the start branch/tag/revision
      * @param endVersion    the end branch/tag/revision
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     DiffScmResult diff( ScmRepository scmRepository, ScmFileSet scmFileSet, ScmVersion startVersion,
                         ScmVersion endVersion )
@@ -344,7 +345,7 @@
      * @param repository the source control system
      * @param fileSet    the files to make editable
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     EditScmResult edit( ScmRepository repository, ScmFileSet fileSet )
         throws ScmException;
@@ -355,7 +356,7 @@
      * @param repository the source control system
      * @param fileSet    the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     ExportScmResult export( ScmRepository repository, ScmFileSet fileSet )
         throws ScmException;
@@ -367,7 +368,7 @@
      * @param fileSet    the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
      * @param version    get the version defined by the branch/tag/revision
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     ExportScmResult export( ScmRepository repository, ScmFileSet fileSet, ScmVersion version )
         throws ScmException;
@@ -379,7 +380,7 @@
      * @param fileSet         the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
      * @param outputDirectory the directory where the export will be stored
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     ExportScmResult export( ScmRepository repository, ScmFileSet fileSet, String outputDirectory )
         throws ScmException;
@@ -392,7 +393,7 @@
      * @param version         get the version defined by the branch/tag/revision
      * @param outputDirectory the directory where the export will be stored
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     ExportScmResult export( ScmRepository repository, ScmFileSet fileSet, ScmVersion version, String outputDirectory )
         throws ScmException;
@@ -416,7 +417,7 @@
      * @param fileSet    the files to be removed
      * @param message
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     RemoveScmResult remove( ScmRepository repository, ScmFileSet fileSet, String message )
         throws ScmException;
@@ -429,7 +430,7 @@
      * @param fileSet    the files to know the status about. Implementations can also give the changes
      *                   from the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} downwards.
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     StatusScmResult status( ScmRepository repository, ScmFileSet fileSet )
         throws ScmException;
@@ -442,7 +443,7 @@
      *                   from the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} downwards.
      * @param tagName    the tag name to apply to the files
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     TagScmResult tag( ScmRepository repository, ScmFileSet fileSet, String tagName )
         throws ScmException;
@@ -456,19 +457,20 @@
      * @param tagName    the tag name to apply to the files
      * @param message    the commit message used for the tag creation
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     TagScmResult tag( ScmRepository repository, ScmFileSet fileSet, String tagName, String message )
         throws ScmException;
 
     /**
-     * Make a file no longer editable. This is the conterpart of {@link #edit(org.apache.maven.scm.repository.ScmRepository,org.apache.maven.scm.ScmFileSet)}.
+     * Make a file no longer editable. This is the conterpart of
+     * {@link #edit(org.apache.maven.scm.repository.ScmRepository,org.apache.maven.scm.ScmFileSet)}.
      * It makes the file read-only again.
      *
      * @param repository the source control system
      * @param fileSet    the files to make uneditable
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     UnEditScmResult unedit( ScmRepository repository, ScmFileSet fileSet )
         throws ScmException;
@@ -479,7 +481,7 @@
      * @param repository the source control system
      * @param fileSet    location of your local copy
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet )
         throws ScmException;
@@ -491,7 +493,7 @@
      * @param fileSet    location of your local copy
      * @param version    use the version defined by the branch/tag/revision
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, ScmVersion version )
         throws ScmException;
@@ -503,7 +505,7 @@
      * @param fileSet      location of your local copy
      * @param runChangelog Run the changelog command after the update
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, boolean runChangelog )
         throws ScmException;
@@ -516,7 +518,7 @@
      * @param version      use the version defined by the branch/tag/revision
      * @param runChangelog Run the changelog command after the update
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, ScmVersion version, boolean runChangelog )
         throws ScmException;
@@ -528,7 +530,7 @@
      * @param fileSet     location of your local copy
      * @param datePattern the date pattern use in changelog output returned by scm tool
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, String datePattern )
         throws ScmException;
@@ -541,7 +543,7 @@
      * @param version     use the version defined by the branch/tag/revision
      * @param datePattern the date pattern use in changelog output returned by scm tool
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, ScmVersion version, String datePattern )
         throws ScmException;
@@ -553,7 +555,7 @@
      * @param fileSet    location of your local copy
      * @param lastUpdate
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, Date lastUpdate )
         throws ScmException;
@@ -566,7 +568,7 @@
      * @param version    use the version defined by the branch/tag/revision
      * @param lastUpdate
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, ScmVersion version, Date lastUpdate )
         throws ScmException;
@@ -579,7 +581,7 @@
      * @param lastUpdate  Date of last update
      * @param datePattern the date pattern use in changelog output returned by scm tool
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, Date lastUpdate, String datePattern )
         throws ScmException;
@@ -593,7 +595,7 @@
      * @param lastUpdate  Date of last update
      * @param datePattern the date pattern use in changelog output returned by scm tool
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, ScmVersion version, Date lastUpdate,
                             String datePattern )

Modified: maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/provider/AbstractScmProvider.java
URL: http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/provider/AbstractScmProvider.java?rev=686197&r1=686196&r2=686197&view=diff
==============================================================================
--- maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/provider/AbstractScmProvider.java (original)
+++ maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/provider/AbstractScmProvider.java Fri Aug 15 05:13:29 2008
@@ -583,7 +583,7 @@
      * @param parameters
      * @return The list of files in the repository
      * @throws NoSuchCommandScmException unless overriden by subclass
-     * @throws ScmException
+     * @throws ScmException if any
      */
     protected ListScmResult list( ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters )
         throws ScmException

Modified: maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProvider.java
URL: http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProvider.java?rev=686197&r1=686196&r2=686197&view=diff
==============================================================================
--- maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProvider.java (original)
+++ maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProvider.java Fri Aug 15 05:13:29 2008
@@ -109,7 +109,7 @@
      * @param repository the source control system
      * @param fileSet    the files to be added
      * @return an {@link AddScmResult} that contains the files that have been added
-     * @throws ScmException
+     * @throws ScmException if any
      */
     AddScmResult add( ScmRepository repository, ScmFileSet fileSet )
         throws ScmException;
@@ -121,7 +121,7 @@
      * @param fileSet    the files to be added
      * @param message    a string that is a comment on the new added file
      * @return an {@link AddScmResult} that contains the files that have been added
-     * @throws ScmException
+     * @throws ScmException if any
      */
     AddScmResult add( ScmRepository repository, ScmFileSet fileSet, String message )
         throws ScmException;
@@ -134,7 +134,7 @@
      *                   from the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} downwards.
      * @param branchName the branch name to apply to the files
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     BranchScmResult branch( ScmRepository repository, ScmFileSet fileSet, String branchName )
         throws ScmException;
@@ -148,7 +148,7 @@
      * @param branchName the branch name to apply to the files
      * @param message    the commit message used for the tag creation
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     BranchScmResult branch( ScmRepository repository, ScmFileSet fileSet, String branchName, String message )
         throws ScmException;
@@ -165,8 +165,9 @@
      * @param numDays    the number days before the current time if startdate and enddate are null
      * @param branch     the branch/tag name
      * @return The SCM result of the changelog command
-     * @throws ScmException
-     * @deprecated you must use {@link ScmProvider#changeLog(org.apache.maven.scm.repository.ScmRepository,org.apache.maven.scm.ScmFileSet,java.util.Date,java.util.Date,int,org.apache.maven.scm.ScmBranch)}
+     * @throws ScmException if any
+     * @deprecated you must use {@link ScmProvider#changeLog(org.apache.maven.scm.repository.ScmRepository,
+     * org.apache.maven.scm.ScmFileSet,java.util.Date,java.util.Date,int,org.apache.maven.scm.ScmBranch)}
      */
     ChangeLogScmResult changeLog( ScmRepository repository, ScmFileSet fileSet, Date startDate, Date endDate,
                                   int numDays, String branch )
@@ -184,7 +185,7 @@
      * @param numDays    the number days before the current time if startdate and enddate are null
      * @param branch     the branch/tag
      * @return The SCM result of the changelog command
-     * @throws ScmException
+     * @throws ScmException if any
      */
     ChangeLogScmResult changeLog( ScmRepository repository, ScmFileSet fileSet, Date startDate, Date endDate,
                                   int numDays, ScmBranch branch )
@@ -203,8 +204,9 @@
      * @param branch      the branch/tag name
      * @param datePattern the date pattern use in changelog output returned by scm tool
      * @return The SCM result of the changelog command
-     * @throws ScmException
-     * @deprecated you must use {@link ScmProvider#changeLog(org.apache.maven.scm.repository.ScmRepository,org.apache.maven.scm.ScmFileSet,java.util.Date,java.util.Date,int,org.apache.maven.scm.ScmBranch,String)}
+     * @throws ScmException if any
+     * @deprecated you must use {@link ScmProvider#changeLog(org.apache.maven.scm.repository.ScmRepository,
+     * org.apache.maven.scm.ScmFileSet,java.util.Date,java.util.Date,int,org.apache.maven.scm.ScmBranch,String)}
      */
     ChangeLogScmResult changeLog( ScmRepository repository, ScmFileSet fileSet, Date startDate, Date endDate,
                                   int numDays, String branch, String datePattern )
@@ -223,7 +225,7 @@
      * @param branch      the branch/tag
      * @param datePattern the date pattern use in changelog output returned by scm tool
      * @return The SCM result of the changelog command
-     * @throws ScmException
+     * @throws ScmException if any
      */
     ChangeLogScmResult changeLog( ScmRepository repository, ScmFileSet fileSet, Date startDate, Date endDate,
                                   int numDays, ScmBranch branch, String datePattern )
@@ -239,8 +241,9 @@
      * @param startTag   the start tag
      * @param endTag     the end tag
      * @return The SCM result of the changelog command
-     * @throws ScmException
-     * @deprecated you must use {@link ScmProvider#changeLog(org.apache.maven.scm.repository.ScmRepository,org.apache.maven.scm.ScmFileSet,org.apache.maven.scm.ScmVersion,org.apache.maven.scm.ScmVersion)}
+     * @throws ScmException if any
+     * @deprecated you must use {@link ScmProvider#changeLog(org.apache.maven.scm.repository.ScmRepository,
+     * org.apache.maven.scm.ScmFileSet,org.apache.maven.scm.ScmVersion,org.apache.maven.scm.ScmVersion)}
      */
     ChangeLogScmResult changeLog( ScmRepository repository, ScmFileSet fileSet, String startTag, String endTag )
         throws ScmException;
@@ -255,7 +258,7 @@
      * @param startVersion the start branch/tag/revision
      * @param endVersion   the end branch/tag/revision
      * @return The SCM result of the changelog command
-     * @throws ScmException
+     * @throws ScmException if any
      */
     ChangeLogScmResult changeLog( ScmRepository repository, ScmFileSet fileSet, ScmVersion startVersion,
                                   ScmVersion endVersion )
@@ -272,8 +275,9 @@
      * @param endTag      the end tag
      * @param datePattern the date pattern use in changelog output returned by scm tool
      * @return
-     * @throws ScmException
-     * @deprecated you must use {@link ScmProvider#changeLog(org.apache.maven.scm.repository.ScmRepository,org.apache.maven.scm.ScmFileSet,org.apache.maven.scm.ScmVersion,org.apache.maven.scm.ScmVersion,String)}
+     * @throws ScmException if any
+     * @deprecated you must use {@link ScmProvider#changeLog(org.apache.maven.scm.repository.ScmRepository,
+     * org.apache.maven.scm.ScmFileSet,org.apache.maven.scm.ScmVersion,org.apache.maven.scm.ScmVersion,String)}
      */
     ChangeLogScmResult changeLog( ScmRepository repository, ScmFileSet fileSet, String startTag, String endTag,
                                   String datePattern )
@@ -290,7 +294,7 @@
      * @param endRevision   the end revision
      * @param datePattern   the date pattern use in changelog output returned by scm tool
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     ChangeLogScmResult changeLog( ScmRepository repository, ScmFileSet fileSet, ScmVersion startRevision,
                                   ScmVersion endRevision, String datePattern )
@@ -309,8 +313,9 @@
      * @param tag        tag or revision
      * @param message    a string that is a comment on the changes that where done
      * @return
-     * @throws ScmException
-     * @deprecated you must use {@link ScmProvider#checkIn(org.apache.maven.scm.repository.ScmRepository,org.apache.maven.scm.ScmFileSet,org.apache.maven.scm.ScmVersion,String)}
+     * @throws ScmException if any
+     * @deprecated you must use {@link ScmProvider#checkIn(org.apache.maven.scm.repository.ScmRepository,
+     * org.apache.maven.scm.ScmFileSet,org.apache.maven.scm.ScmVersion,String)}
      */
     CheckInScmResult checkIn( ScmRepository repository, ScmFileSet fileSet, String tag, String message )
         throws ScmException;
@@ -327,7 +332,7 @@
      * @param fileSet    the files to check in (sometimes called commit)
      * @param message    a string that is a comment on the changes that where done
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     CheckInScmResult checkIn( ScmRepository repository, ScmFileSet fileSet, String message )
         throws ScmException;
@@ -345,7 +350,7 @@
      * @param revision   branch/tag/revision
      * @param message    a string that is a comment on the changes that where done
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     CheckInScmResult checkIn( ScmRepository repository, ScmFileSet fileSet, ScmVersion revision, String message )
         throws ScmException;
@@ -357,8 +362,9 @@
      * @param fileSet    the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
      * @param tag        get the version defined by the tag
      * @return
-     * @throws ScmException
-     * @deprecated you must use {@link ScmProvider#checkOut(org.apache.maven.scm.repository.ScmRepository,org.apache.maven.scm.ScmFileSet,org.apache.maven.scm.ScmVersion)}
+     * @throws ScmException if any
+     * @deprecated you must use {@link ScmProvider#checkOut(org.apache.maven.scm.repository.ScmRepository,
+     * org.apache.maven.scm.ScmFileSet,org.apache.maven.scm.ScmVersion)}
      */
     CheckOutScmResult checkOut( ScmRepository repository, ScmFileSet fileSet, String tag )
         throws ScmException;
@@ -369,7 +375,7 @@
      * @param repository the source control system
      * @param fileSet    the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     CheckOutScmResult checkOut( ScmRepository repository, ScmFileSet fileSet )
         throws ScmException;
@@ -381,7 +387,7 @@
      * @param fileSet    the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
      * @param version    get the version defined by the revision, branch or tag
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     CheckOutScmResult checkOut( ScmRepository repository, ScmFileSet fileSet, ScmVersion version )
         throws ScmException;
@@ -394,8 +400,9 @@
      * @param tag           tag or revision
      * @param recursive     whether to check out recursively
      * @return
-     * @throws ScmException
-     * @deprecated you must use {@link ScmProvider#checkOut(org.apache.maven.scm.repository.ScmRepository,org.apache.maven.scm.ScmFileSet,org.apache.maven.scm.ScmVersion,boolean)}
+     * @throws ScmException if any
+     * @deprecated you must use {@link ScmProvider#checkOut(org.apache.maven.scm.repository.ScmRepository,
+     * org.apache.maven.scm.ScmFileSet,org.apache.maven.scm.ScmVersion,boolean)}
      */
     CheckOutScmResult checkOut( ScmRepository scmRepository, ScmFileSet scmFileSet, String tag, boolean recursive )
         throws ScmException;
@@ -407,7 +414,7 @@
      * @param scmFileSet    the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
      * @param recursive     whether to check out recursively
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     CheckOutScmResult checkOut( ScmRepository scmRepository, ScmFileSet scmFileSet, boolean recursive )
         throws ScmException;
@@ -420,7 +427,7 @@
      * @param version       get the version defined by the revision, branch or tag
      * @param recursive     whether to check out recursively
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     CheckOutScmResult checkOut( ScmRepository scmRepository, ScmFileSet scmFileSet, ScmVersion version,
                                 boolean recursive )
@@ -434,8 +441,9 @@
      * @param startRevision the start revision
      * @param endRevision   the end revision
      * @return
-     * @throws ScmException
-     * @deprecated you must use {@link ScmProvider#diff(org.apache.maven.scm.repository.ScmRepository,org.apache.maven.scm.ScmFileSet,org.apache.maven.scm.ScmVersion,org.apache.maven.scm.ScmVersion)}
+     * @throws ScmException if any
+     * @deprecated you must use {@link ScmProvider#diff(org.apache.maven.scm.repository.ScmRepository,
+     * org.apache.maven.scm.ScmFileSet,org.apache.maven.scm.ScmVersion,org.apache.maven.scm.ScmVersion)}
      */
     DiffScmResult diff( ScmRepository scmRepository, ScmFileSet scmFileSet, String startRevision, String endRevision )
         throws ScmException;
@@ -448,7 +456,7 @@
      * @param startVersion  the start branch/tag/revision
      * @param endVersion    the end branch/tag/revision
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     DiffScmResult diff( ScmRepository scmRepository, ScmFileSet scmFileSet, ScmVersion startVersion,
                         ScmVersion endVersion )
@@ -461,8 +469,9 @@
      * @param fileSet    the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
      * @param tag        get the version defined by the tag
      * @return
-     * @throws ScmException
-     * @deprecated you must use {@link ScmProvider#export(org.apache.maven.scm.repository.ScmRepository,org.apache.maven.scm.ScmFileSet,org.apache.maven.scm.ScmVersion)}
+     * @throws ScmException if any
+     * @deprecated you must use {@link ScmProvider#export(org.apache.maven.scm.repository.ScmRepository,
+     * org.apache.maven.scm.ScmFileSet,org.apache.maven.scm.ScmVersion)}
      */
     ExportScmResult export( ScmRepository repository, ScmFileSet fileSet, String tag )
         throws ScmException;
@@ -473,7 +482,7 @@
      * @param repository the source control system
      * @param fileSet    the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     ExportScmResult export( ScmRepository repository, ScmFileSet fileSet )
         throws ScmException;
@@ -485,7 +494,7 @@
      * @param fileSet    the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
      * @param version    get the version defined by the branch/tag/revision
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     ExportScmResult export( ScmRepository repository, ScmFileSet fileSet, ScmVersion version )
         throws ScmException;
@@ -498,8 +507,9 @@
      * @param tag             get the version defined by the tag
      * @param outputDirectory the directory where the export will be stored
      * @return
-     * @throws ScmException
-     * @deprecated you must use {@link ScmProvider#export(org.apache.maven.scm.repository.ScmRepository,org.apache.maven.scm.ScmFileSet,org.apache.maven.scm.ScmVersion,String)}
+     * @throws ScmException if any
+     * @deprecated you must use {@link ScmProvider#export(org.apache.maven.scm.repository.ScmRepository,
+     * org.apache.maven.scm.ScmFileSet,org.apache.maven.scm.ScmVersion,String)}
      */
     ExportScmResult export( ScmRepository repository, ScmFileSet fileSet, String tag, String outputDirectory )
         throws ScmException;
@@ -512,7 +522,7 @@
      * @param version         get the version defined by the branch/tag/revision
      * @param outputDirectory the directory where the export will be stored
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     ExportScmResult export( ScmRepository repository, ScmFileSet fileSet, ScmVersion version, String outputDirectory )
         throws ScmException;
@@ -524,7 +534,7 @@
      * @param fileSet    the files to be removed
      * @param message
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     RemoveScmResult remove( ScmRepository repository, ScmFileSet fileSet, String message )
         throws ScmException;
@@ -537,7 +547,7 @@
      * @param fileSet    the files to know the status about. Implementations can also give the changes
      *                   from the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} downwards.
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     StatusScmResult status( ScmRepository repository, ScmFileSet fileSet )
         throws ScmException;
@@ -550,7 +560,7 @@
      *                   from the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} downwards.
      * @param tagName    the tag name to apply to the files
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     TagScmResult tag( ScmRepository repository, ScmFileSet fileSet, String tagName )
         throws ScmException;
@@ -564,7 +574,7 @@
      * @param tagName    the tag name to apply to the files
      * @param message    the commit message used for the tag creation
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     TagScmResult tag( ScmRepository repository, ScmFileSet fileSet, String tagName, String message )
         throws ScmException;
@@ -575,7 +585,7 @@
      * @param repository the source control system
      * @param fileSet    location of your local copy
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet )
         throws ScmException;
@@ -587,8 +597,9 @@
      * @param fileSet    location of your local copy
      * @param tag        use the version defined by the tag
      * @return
-     * @throws ScmException
-     * @deprecated you must use {@link ScmProvider#update(org.apache.maven.scm.repository.ScmRepository,org.apache.maven.scm.ScmFileSet,org.apache.maven.scm.ScmVersion)}
+     * @throws ScmException if any
+     * @deprecated you must use {@link ScmProvider#update(org.apache.maven.scm.repository.ScmRepository,
+     * org.apache.maven.scm.ScmFileSet,org.apache.maven.scm.ScmVersion)}
      */
     UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, String tag )
         throws ScmException;
@@ -600,7 +611,7 @@
      * @param fileSet    location of your local copy
      * @param version    use the version defined by the branch/tag/revision
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, ScmVersion version )
         throws ScmException;
@@ -613,8 +624,9 @@
      * @param tag          use the version defined by the tag
      * @param runChangelog Run the changelog command after the update
      * @return
-     * @throws ScmException
-     * @deprecated you must use {@link ScmProvider#update(org.apache.maven.scm.repository.ScmRepository,org.apache.maven.scm.ScmFileSet,org.apache.maven.scm.ScmVersion,boolean)}
+     * @throws ScmException if any
+     * @deprecated you must use {@link ScmProvider#update(org.apache.maven.scm.repository.ScmRepository,
+     * org.apache.maven.scm.ScmFileSet,org.apache.maven.scm.ScmVersion,boolean)}
      */
     UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, String tag, boolean runChangelog )
         throws ScmException;
@@ -626,7 +638,7 @@
      * @param fileSet      location of your local copy
      * @param runChangelog Run the changelog command after the update
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, boolean runChangelog )
         throws ScmException;
@@ -639,7 +651,7 @@
      * @param version      use the version defined by the branch/tag/revision
      * @param runChangelog Run the changelog command after the update
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, ScmVersion version, boolean runChangelog )
         throws ScmException;
@@ -652,8 +664,9 @@
      * @param tag         use the version defined by the tag
      * @param datePattern the date pattern use in changelog output returned by scm tool
      * @return
-     * @throws ScmException
-     * @deprecated you must use {@link ScmProvider#update(org.apache.maven.scm.repository.ScmRepository,org.apache.maven.scm.ScmFileSet,org.apache.maven.scm.ScmVersion,String)}
+     * @throws ScmException if any
+     * @deprecated you must use {@link ScmProvider#update(org.apache.maven.scm.repository.ScmRepository,
+     * org.apache.maven.scm.ScmFileSet,org.apache.maven.scm.ScmVersion,String)}
      */
     UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, String tag, String datePattern )
         throws ScmException;
@@ -666,7 +679,7 @@
      * @param version     use the version defined by the branch/tag/revision
      * @param datePattern the date pattern use in changelog output returned by scm tool
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, ScmVersion version, String datePattern )
         throws ScmException;
@@ -679,8 +692,9 @@
      * @param tag        use the version defined by the tag
      * @param lastUpdate
      * @return
-     * @throws ScmException
-     * @deprecated you must use {@link ScmProvider#update(org.apache.maven.scm.repository.ScmRepository,org.apache.maven.scm.ScmFileSet,org.apache.maven.scm.ScmVersion,java.util.Date)}
+     * @throws ScmException if any
+     * @deprecated you must use {@link ScmProvider#update(org.apache.maven.scm.repository.ScmRepository,
+     * org.apache.maven.scm.ScmFileSet,org.apache.maven.scm.ScmVersion,java.util.Date)}
      */
     UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, String tag, Date lastUpdate )
         throws ScmException;
@@ -693,7 +707,7 @@
      * @param version    use the version defined by the branch/tag/revision
      * @param lastUpdate
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, ScmVersion version, Date lastUpdate )
         throws ScmException;
@@ -707,8 +721,9 @@
      * @param lastUpdate  Date of last update
      * @param datePattern the date pattern use in changelog output returned by scm tool
      * @return
-     * @throws ScmException
-     * @deprecated you must use {@link ScmProvider#update(org.apache.maven.scm.repository.ScmRepository,org.apache.maven.scm.ScmFileSet,org.apache.maven.scm.ScmVersion,java.util.Date,String)}
+     * @throws ScmException if any
+     * @deprecated you must use {@link ScmProvider#update(org.apache.maven.scm.repository.ScmRepository,
+     * org.apache.maven.scm.ScmFileSet,org.apache.maven.scm.ScmVersion,java.util.Date,String)}
      */
     UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, String tag, Date lastUpdate,
                             String datePattern )
@@ -723,7 +738,7 @@
      * @param lastUpdate  Date of last update
      * @param datePattern the date pattern use in changelog output returned by scm tool
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, ScmVersion version, Date lastUpdate,
                             String datePattern )
@@ -737,19 +752,20 @@
      * @param repository the source control system
      * @param fileSet    the files to make editable
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     EditScmResult edit( ScmRepository repository, ScmFileSet fileSet )
         throws ScmException;
 
     /**
-     * Make a file no longer editable. This is the conterpart of {@link #edit(org.apache.maven.scm.repository.ScmRepository,org.apache.maven.scm.ScmFileSet)}.
+     * Make a file no longer editable. This is the conterpart of {@link #edit(
+     * org.apache.maven.scm.repository.ScmRepository,org.apache.maven.scm.ScmFileSet)}.
      * It makes the file read-only again.
      *
      * @param repository the source control system
      * @param fileSet    the files to make uneditable
      * @return
-     * @throws ScmException
+     * @throws ScmException if any
      */
     UnEditScmResult unedit( ScmRepository repository, ScmFileSet fileSet )
         throws ScmException;
@@ -762,7 +778,8 @@
      * @param recursive  descend recursively
      * @param tag        use the version defined by the tag
      * @return the list of files in the repository
-     * @deprecated you must use {@link ScmProvider#list(org.apache.maven.scm.repository.ScmRepository,org.apache.maven.scm.ScmFileSet,boolean,org.apache.maven.scm.ScmVersion)}
+     * @deprecated you must use {@link ScmProvider#list(org.apache.maven.scm.repository.ScmRepository,
+     * org.apache.maven.scm.ScmFileSet,boolean,org.apache.maven.scm.ScmVersion)}
      */
     ListScmResult list( ScmRepository repository, ScmFileSet fileSet, boolean recursive, String tag )
         throws ScmException;
@@ -775,6 +792,7 @@
      * @param recursive  descend recursively
      * @param version    use the version defined by the branch/tag/revision
      * @return the list of files in the repository
+     * @throws ScmException if any
      */
     ListScmResult list( ScmRepository repository, ScmFileSet fileSet, boolean recursive, ScmVersion version )
         throws ScmException;

Modified: maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmUrlUtils.java
URL: http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmUrlUtils.java?rev=686197&r1=686196&r2=686197&view=diff
==============================================================================
--- maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmUrlUtils.java (original)
+++ maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmUrlUtils.java Fri Aug 15 05:13:29 2008
@@ -36,8 +36,9 @@
  */
 public abstract class ScmUrlUtils
 {
-    private static final String ILLEGAL_SCM_URL = "The scm url must be on the form " +
-        "'scm:<scm provider><delimiter><provider specific part>' " + "where <delimiter> can be either ':' or '|'.";
+    private static final String ILLEGAL_SCM_URL =
+        "The scm url must be on the form 'scm:<scm provider><delimiter><provider specific part>' "
+            + "where <delimiter> can be either ':' or '|'.";
 
     /**
      * Get the delimiter used in the scm url.