View Javadoc

1   package org.apache.maven.scm.command.tag;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   * http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.scm.CommandParameter;
23  import org.apache.maven.scm.CommandParameters;
24  import org.apache.maven.scm.ScmException;
25  import org.apache.maven.scm.ScmFileSet;
26  import org.apache.maven.scm.ScmResult;
27  import org.apache.maven.scm.ScmTagParameters;
28  import org.apache.maven.scm.command.AbstractCommand;
29  import org.apache.maven.scm.provider.ScmProviderRepository;
30  
31  /**
32   * @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
33   * @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>
34   *
35   */
36  public abstract class AbstractTagCommand
37      extends AbstractCommand
38  {
39      /**
40       * @deprecated use method {@link #executeTagCommand(ScmProviderRepository, ScmFileSet, String, ScmTagParameters)} 
41       * @param repository
42       * @param fileSet
43       * @param tagName
44       * @param message
45       * @return
46       * @throws ScmException
47       */
48      protected ScmResult executeTagCommand( ScmProviderRepository repository, ScmFileSet fileSet, String tagName,
49                                             String message )
50          throws ScmException
51      {
52          return executeTagCommand( repository, fileSet, tagName, new ScmTagParameters( message ) );
53      }
54  
55      protected abstract ScmResult executeTagCommand( ScmProviderRepository repository, ScmFileSet fileSet,
56                                                      String tagName, ScmTagParameters scmTagParameters )
57          throws ScmException;    
58      
59      /** {@inheritDoc} */
60      public ScmResult executeCommand( ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters )
61          throws ScmException
62      {
63          String tagName = parameters.getString( CommandParameter.TAG_NAME );
64  
65          ScmTagParameters scmTagParameters = parameters.getScmTagParameters( CommandParameter.SCM_TAG_PARAMETERS );
66  
67          String message = parameters.getString( CommandParameter.MESSAGE, null );
68  
69          if ( message != null )
70          {
71              // if message was passed by CommandParameter.MESSAGE then use it.
72              scmTagParameters.setMessage( message );
73          }
74  
75          if ( scmTagParameters.getMessage() == null )
76          {
77              // if message hasn't been passed nor by ScmTagParameters nor by CommandParameter.MESSAGE then use default.
78              scmTagParameters.setMessage( "[maven-scm] copy for tag " + tagName );
79          }
80  
81          return executeTagCommand( repository, fileSet, tagName, scmTagParameters );
82      }
83      
84  }