1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.scm.command.untag;
20
21 import org.apache.maven.scm.CommandParameter;
22 import org.apache.maven.scm.CommandParameters;
23 import org.apache.maven.scm.ScmException;
24 import org.apache.maven.scm.ScmFileSet;
25 import org.apache.maven.scm.ScmResult;
26 import org.apache.maven.scm.ScmUntagParameters;
27 import org.apache.maven.scm.command.AbstractCommand;
28 import org.apache.maven.scm.provider.ScmProviderRepository;
29
30 /** Removes a tag. */
31 public abstract class AbstractUntagCommand extends AbstractCommand {
32 /**
33 * Execute untag command.
34 *
35 * @param repository scm repo
36 * @param fileSet set of files (unused)
37 * @param scmUntagParameters parameters used by untag implementations
38 * @return result of untag command
39 * @throws ScmException in case of error
40 */
41 protected abstract ScmResult executeUntagCommand(
42 ScmProviderRepository repository, ScmFileSet fileSet, ScmUntagParameters scmUntagParameters)
43 throws ScmException;
44
45 /**
46 * {@inheritDoc}
47 */
48 @Override
49 public ScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
50 throws ScmException {
51 String tagName = parameters.getString(CommandParameter.TAG_NAME);
52 String message = parameters.getString(CommandParameter.MESSAGE, "[maven-scm] remove tag " + tagName);
53 ScmUntagParameters scmUntagParameters = new ScmUntagParameters(tagName, message);
54
55 return executeUntagCommand(repository, fileSet, scmUntagParameters);
56 }
57 }