001package org.apache.maven.scm.command.untag;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 * http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.apache.maven.scm.CommandParameter;
023import org.apache.maven.scm.CommandParameters;
024import org.apache.maven.scm.ScmException;
025import org.apache.maven.scm.ScmFileSet;
026import org.apache.maven.scm.ScmResult;
027import org.apache.maven.scm.ScmUntagParameters;
028import org.apache.maven.scm.command.AbstractCommand;
029import org.apache.maven.scm.provider.ScmProviderRepository;
030
031/** {@inheritDoc} */
032public abstract class AbstractUntagCommand
033    extends AbstractCommand
034{
035    /**
036     * execute untag command
037     *
038     * @param repository         scm repo
039     * @param fileSet            set of files (unused)
040     * @param scmUntagParameters parameters used by untag implementations
041     * @return result of untag command
042     * @throws ScmException  in case of error
043     */
044    protected abstract ScmResult executeUntagCommand( ScmProviderRepository repository,
045                                                      ScmFileSet fileSet, ScmUntagParameters scmUntagParameters )
046        throws ScmException;
047
048    /** {@inheritDoc} */
049    @Override
050    public ScmResult executeCommand( ScmProviderRepository repository, ScmFileSet fileSet,
051                                     CommandParameters parameters )
052        throws ScmException
053    {
054        String tagName = parameters.getString( CommandParameter.TAG_NAME );
055        String message = parameters.getString( CommandParameter.MESSAGE, "[maven-scm] remove tag " + tagName );
056        ScmUntagParameters scmUntagParameters = new ScmUntagParameters( tagName, message );
057
058        return executeUntagCommand( repository, fileSet, scmUntagParameters );
059    }
060
061}