View Javadoc
1   package org.apache.maven.scm.command.untag;
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.ScmUntagParameters;
28  import org.apache.maven.scm.command.AbstractCommand;
29  import org.apache.maven.scm.provider.ScmProviderRepository;
30  
31  /** {@inheritDoc} */
32  public abstract class AbstractUntagCommand
33      extends AbstractCommand
34  {
35      /**
36       * execute untag command
37       *
38       * @param repository         scm repo
39       * @param fileSet            set of files (unused)
40       * @param scmUntagParameters parameters used by untag implementations
41       * @return result of untag command
42       * @throws ScmException  in case of error
43       */
44      protected abstract ScmResult executeUntagCommand( ScmProviderRepository repository,
45                                                        ScmFileSet fileSet, ScmUntagParameters scmUntagParameters )
46          throws ScmException;
47  
48      /** {@inheritDoc} */
49      @Override
50      public ScmResult executeCommand( ScmProviderRepository repository, ScmFileSet fileSet,
51                                       CommandParameters parameters )
52          throws ScmException
53      {
54          String tagName = parameters.getString( CommandParameter.TAG_NAME );
55          String message = parameters.getString( CommandParameter.MESSAGE, "[maven-scm] remove tag " + tagName );
56          ScmUntagParameters scmUntagParameters = new ScmUntagParameters( tagName, message );
57  
58          return executeUntagCommand( repository, fileSet, scmUntagParameters );
59      }
60  
61  }