001    package 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    
022    import org.apache.maven.scm.CommandParameter;
023    import org.apache.maven.scm.CommandParameters;
024    import org.apache.maven.scm.ScmException;
025    import org.apache.maven.scm.ScmFileSet;
026    import org.apache.maven.scm.ScmResult;
027    import org.apache.maven.scm.ScmVersion;
028    import org.apache.maven.scm.command.AbstractCommand;
029    import 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     */
037    public 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)
049         */
050        protected CheckOutScmResult executeCheckOutCommand( ScmProviderRepository repository, ScmFileSet fileSet,
051                                                                     ScmVersion scmVersion )
052            throws ScmException
053        {
054            return executeCheckOutCommand( repository, fileSet, scmVersion, true );
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         * @return the checkout result
065         * @throws ScmException if any
066         * @since 1.1.1
067         */
068        protected abstract CheckOutScmResult executeCheckOutCommand( ScmProviderRepository repository, ScmFileSet fileSet,
069                                                                     ScmVersion scmVersion, boolean recursive )
070            throws ScmException;
071    
072        /** {@inheritDoc} */
073        public ScmResult executeCommand( ScmProviderRepository repository, ScmFileSet fileSet,
074                                         CommandParameters parameters )
075            throws ScmException
076        {
077            ScmVersion scmVersion = parameters.getScmVersion( CommandParameter.SCM_VERSION, null );
078            String recursiveParam = parameters.getString( CommandParameter.RECURSIVE, null );
079            if ( recursiveParam != null )
080            {
081                boolean recursive = parameters.getBoolean( CommandParameter.RECURSIVE );
082                return executeCheckOutCommand( repository, fileSet, scmVersion, recursive );
083            }
084    
085            return executeCheckOutCommand( repository, fileSet, scmVersion );
086        }
087    }