View Javadoc
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.branch;
20  
21  import org.apache.commons.lang3.StringUtils;
22  import org.apache.maven.scm.CommandParameter;
23  import org.apache.maven.scm.CommandParameters;
24  import org.apache.maven.scm.ScmBranchParameters;
25  import org.apache.maven.scm.ScmException;
26  import org.apache.maven.scm.ScmFileSet;
27  import org.apache.maven.scm.ScmResult;
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 AbstractBranchCommand extends AbstractCommand {
37      protected abstract ScmResult executeBranchCommand(
38              ScmProviderRepository repository, ScmFileSet fileSet, String branchName, String message)
39              throws ScmException;
40  
41      /**
42       * default impl to provide backward comp
43       * @since 1.3
44       * @param repository TODO
45       * @param fileSet TODO
46       * @param branchName TODO
47       * @param scmBranchParameters TODO
48       * @return TODO
49       * @throws ScmException if any
50       */
51      protected ScmResult executeBranchCommand(
52              ScmProviderRepository repository,
53              ScmFileSet fileSet,
54              String branchName,
55              ScmBranchParameters scmBranchParameters)
56              throws ScmException {
57          return executeBranchCommand(repository, fileSet, branchName, scmBranchParameters.getMessage());
58      }
59  
60      /** {@inheritDoc} */
61      public ScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
62              throws ScmException {
63          String branchName = parameters.getString(CommandParameter.BRANCH_NAME);
64  
65          ScmBranchParameters scmBranchParameters =
66                  parameters.getScmBranchParameters(CommandParameter.SCM_BRANCH_PARAMETERS);
67  
68          String message = parameters.getString(CommandParameter.MESSAGE, "[maven-scm] copy for branch " + branchName);
69  
70          if (StringUtils.isBlank(scmBranchParameters.getMessage()) && StringUtils.isNotBlank(message)) {
71              scmBranchParameters.setMessage(message);
72          }
73  
74          return executeBranchCommand(repository, fileSet, branchName, scmBranchParameters);
75      }
76  }