001package org.apache.maven.scm.command.checkin;
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.ScmVersion;
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&oslash;l</a>
034 * @author Olivier Lamy
035 *
036 */
037public abstract class AbstractCheckInCommand
038    extends AbstractCommand
039{
040    public static final String NAME = "check-in";
041
042    protected abstract CheckInScmResult executeCheckInCommand( ScmProviderRepository repository, ScmFileSet fileSet,
043                                                               String message, ScmVersion scmVersion )
044        throws ScmException;
045
046    public ScmResult executeCommand( ScmProviderRepository repository, ScmFileSet fileSet,
047                                     CommandParameters parameters )
048        throws ScmException
049    {
050        String message = parameters.getString( CommandParameter.MESSAGE );
051
052        ScmVersion scmVersion = parameters.getScmVersion( CommandParameter.SCM_VERSION, null );
053
054        return executeCheckInCommand( repository, fileSet, message, scmVersion );
055    }
056}