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.checkin;
20  
21  import org.apache.maven.scm.CommandParameter;
22  import org.apache.maven.scm.CommandParameters;
23  import org.apache.maven.scm.CommandParameters.SignOption;
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.ScmVersion;
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   * @author Olivier Lamy
35   */
36  public abstract class AbstractCheckInCommand extends AbstractCommand {
37      public static final String NAME = "check-in";
38  
39      protected CheckInScmResult executeCheckInCommand(
40              ScmProviderRepository repository,
41              ScmFileSet fileSet,
42              String message,
43              ScmVersion scmVersion,
44              SignOption signOption)
45              throws ScmException {
46          return executeCheckInCommand(repository, fileSet, message, scmVersion);
47      }
48  
49      /**
50       * @param repository
51       * @param fileSet
52       * @param message
53       * @param scmVersion
54       * @return
55       * @throws ScmException
56       * @deprecated use {@link #executeCheckInCommand(ScmProviderRepository, ScmFileSet, String, ScmVersion, SignOption)}
57       */
58      @Deprecated
59      protected abstract CheckInScmResult executeCheckInCommand(
60              ScmProviderRepository repository, ScmFileSet fileSet, String message, ScmVersion scmVersion)
61              throws ScmException;
62  
63      public ScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
64              throws ScmException {
65          String message = parameters.getString(CommandParameter.MESSAGE);
66  
67          ScmVersion scmVersion = parameters.getScmVersion(CommandParameter.SCM_VERSION, null);
68          SignOption signOption = parameters.getSignOption(CommandParameter.SIGN_OPTION);
69          return executeCheckInCommand(repository, fileSet, message, scmVersion, signOption);
70      }
71  }