001package org.apache.maven.scm.command.tag; 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.ScmTagParameters; 028import org.apache.maven.scm.command.AbstractCommand; 029import org.apache.maven.scm.provider.ScmProviderRepository; 030 031/** 032 * @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a> 033 * @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a> 034 * 035 */ 036public abstract class AbstractTagCommand 037 extends AbstractCommand 038{ 039 /** 040 * @deprecated use method {@link #executeTagCommand(ScmProviderRepository, ScmFileSet, String, ScmTagParameters)} 041 * @param repository TODO 042 * @param fileSet TODO 043 * @param tagName TODO 044 * @param message TODO 045 * @return TODO 046 * @throws ScmException if any 047 */ 048 protected ScmResult executeTagCommand( ScmProviderRepository repository, ScmFileSet fileSet, String tagName, 049 String message ) 050 throws ScmException 051 { 052 return executeTagCommand( repository, fileSet, tagName, new ScmTagParameters( message ) ); 053 } 054 055 protected abstract ScmResult executeTagCommand( ScmProviderRepository repository, ScmFileSet fileSet, 056 String tagName, ScmTagParameters scmTagParameters ) 057 throws ScmException; 058 059 /** {@inheritDoc} */ 060 public ScmResult executeCommand( ScmProviderRepository repository, ScmFileSet fileSet, 061 CommandParameters parameters ) 062 throws ScmException 063 { 064 String tagName = parameters.getString( CommandParameter.TAG_NAME ); 065 066 ScmTagParameters scmTagParameters = parameters.getScmTagParameters( CommandParameter.SCM_TAG_PARAMETERS ); 067 068 String message = parameters.getString( CommandParameter.MESSAGE, null ); 069 070 if ( message != null ) 071 { 072 // if message was passed by CommandParameter.MESSAGE then use it. 073 scmTagParameters.setMessage( message ); 074 } 075 076 if ( scmTagParameters.getMessage() == null ) 077 { 078 // if message hasn't been passed nor by ScmTagParameters nor by CommandParameter.MESSAGE then use default. 079 scmTagParameters.setMessage( "[maven-scm] copy for tag " + tagName ); 080 } 081 082 return executeTagCommand( repository, fileSet, tagName, scmTagParameters ); 083 } 084 085}