View Javadoc
1   package org.apache.maven.scm.command.checkin;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   * http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.scm.CommandParameter;
23  import org.apache.maven.scm.CommandParameters;
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   */
37  public abstract class AbstractCheckInCommand
38      extends AbstractCommand
39  {
40      public static final String NAME = "check-in";
41  
42      protected abstract CheckInScmResult executeCheckInCommand( ScmProviderRepository repository, ScmFileSet fileSet,
43                                                                 String message, ScmVersion scmVersion )
44          throws ScmException;
45  
46      public ScmResult executeCommand( ScmProviderRepository repository, ScmFileSet fileSet,
47                                       CommandParameters parameters )
48          throws ScmException
49      {
50          String message = parameters.getString( CommandParameter.MESSAGE );
51  
52          ScmVersion scmVersion = parameters.getScmVersion( CommandParameter.SCM_VERSION, null );
53  
54          return executeCheckInCommand( repository, fileSet, message, scmVersion );
55      }
56  }