001package org.apache.maven.scm.command.checkout;
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 AbstractCheckOutCommand
038    extends AbstractCommand
039{
040    /**
041     * Execute Check out command line in a recursive check out way.
042     *
043     * @param repository not null
044     * @param fileSet not null
045     * @param scmVersion not null
046     * @return the checkout result
047     * @throws ScmException if any
048     * @see #executeCheckOutCommand(ScmProviderRepository, ScmFileSet, ScmVersion, boolean, boolean)
049     */
050    protected CheckOutScmResult executeCheckOutCommand( ScmProviderRepository repository, ScmFileSet fileSet,
051                                                                 ScmVersion scmVersion )
052        throws ScmException
053    {
054        return executeCheckOutCommand( repository, fileSet, scmVersion, true, false );
055    }
056
057    /**
058     * Execute Check out command line.
059     *
060     * @param repository not null
061     * @param fileSet not null
062     * @param scmVersion not null
063     * @param recursive <code>true</code> if recursive check out is wanted, <code>false</code> otherwise.
064     * @param shallow <code>true</code> if shallow check out is wanted, <code>false</code> otherwise.
065     * @return the checkout result
066     * @throws ScmException if any
067     * @since 1.1.1
068     */
069    protected abstract CheckOutScmResult executeCheckOutCommand( ScmProviderRepository repository, ScmFileSet fileSet,
070                                                                ScmVersion scmVersion, boolean recursive,
071                                                                boolean shallow )
072        throws ScmException;
073
074    /** {@inheritDoc} */
075    public ScmResult executeCommand( ScmProviderRepository repository, ScmFileSet fileSet,
076                                     CommandParameters parameters )
077        throws ScmException
078    {
079        ScmVersion scmVersion = parameters.getScmVersion( CommandParameter.SCM_VERSION, null );
080        boolean recursive = parameters.getBoolean( CommandParameter.RECURSIVE, true );
081        boolean shallow = parameters.getBoolean( CommandParameter.SHALLOW, false );
082        return executeCheckOutCommand( repository, fileSet, scmVersion, recursive, shallow);
083    }
084}