001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.maven.scm.command.checkout;
020
021import org.apache.maven.scm.CommandParameter;
022import org.apache.maven.scm.CommandParameters;
023import org.apache.maven.scm.ScmException;
024import org.apache.maven.scm.ScmFileSet;
025import org.apache.maven.scm.ScmResult;
026import org.apache.maven.scm.ScmVersion;
027import org.apache.maven.scm.command.AbstractCommand;
028import org.apache.maven.scm.provider.ScmProviderRepository;
029
030/**
031 * @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
032 * @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>
033 * @author Olivier Lamy
034 */
035public abstract class AbstractCheckOutCommand extends AbstractCommand {
036    /**
037     * Execute Check out command line in a recursive check out way.
038     *
039     * @param repository not null
040     * @param fileSet not null
041     * @param scmVersion not null
042     * @return the checkout result
043     * @throws ScmException if any
044     * @see #executeCheckOutCommand(ScmProviderRepository, ScmFileSet, ScmVersion, boolean, boolean)
045     */
046    protected CheckOutScmResult executeCheckOutCommand(
047            ScmProviderRepository repository, ScmFileSet fileSet, ScmVersion scmVersion) throws ScmException {
048        return executeCheckOutCommand(repository, fileSet, scmVersion, true, false);
049    }
050
051    /**
052     * Execute Check out command line.
053     *
054     * @param repository not null
055     * @param fileSet not null
056     * @param scmVersion not null
057     * @param recursive <code>true</code> if recursive check out is wanted, <code>false</code> otherwise
058     * @param shallow <code>true</code> if shallow check out is wanted, <code>false</code> otherwise
059     * @return the checkout result
060     * @throws ScmException if any
061     * @since 1.1.1
062     */
063    protected abstract CheckOutScmResult executeCheckOutCommand(
064            ScmProviderRepository repository,
065            ScmFileSet fileSet,
066            ScmVersion scmVersion,
067            boolean recursive,
068            boolean shallow)
069            throws ScmException;
070
071    /**
072     * {@inheritDoc}
073     */
074    public ScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
075            throws ScmException {
076        ScmVersion scmVersion = parameters.getScmVersion(CommandParameter.SCM_VERSION, null);
077        boolean recursive = parameters.getBoolean(CommandParameter.RECURSIVE, true);
078        boolean shallow = parameters.getBoolean(CommandParameter.SHALLOW, false);
079        return executeCheckOutCommand(repository, fileSet, scmVersion, recursive, shallow);
080    }
081}