1 package org.apache.maven.scm.command.checkout;
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øl</a>
34 * @author Olivier Lamy
35 *
36 */
37 public abstract class AbstractCheckOutCommand
38 extends AbstractCommand
39 {
40 /**
41 * Execute Check out command line in a recursive check out way.
42 *
43 * @param repository not null
44 * @param fileSet not null
45 * @param scmVersion not null
46 * @return the checkout result
47 * @throws ScmException if any
48 * @see #executeCheckOutCommand(ScmProviderRepository, ScmFileSet, ScmVersion, boolean, boolean)
49 */
50 protected CheckOutScmResult executeCheckOutCommand( ScmProviderRepository repository, ScmFileSet fileSet,
51 ScmVersion scmVersion )
52 throws ScmException
53 {
54 return executeCheckOutCommand( repository, fileSet, scmVersion, true, false );
55 }
56
57 /**
58 * Execute Check out command line.
59 *
60 * @param repository not null
61 * @param fileSet not null
62 * @param scmVersion not null
63 * @param recursive <code>true</code> if recursive check out is wanted, <code>false</code> otherwise.
64 * @param shallow <code>true</code> if shallow check out is wanted, <code>false</code> otherwise.
65 * @return the checkout result
66 * @throws ScmException if any
67 * @since 1.1.1
68 */
69 protected abstract CheckOutScmResult executeCheckOutCommand( ScmProviderRepository repository, ScmFileSet fileSet,
70 ScmVersion scmVersion, boolean recursive,
71 boolean shallow )
72 throws ScmException;
73
74 /** {@inheritDoc} */
75 public ScmResult executeCommand( ScmProviderRepository repository, ScmFileSet fileSet,
76 CommandParameters parameters )
77 throws ScmException
78 {
79 ScmVersion scmVersion = parameters.getScmVersion( CommandParameter.SCM_VERSION, null );
80 boolean recursive = parameters.getBoolean( CommandParameter.RECURSIVE, true );
81 boolean shallow = parameters.getBoolean( CommandParameter.SHALLOW, false );
82 return executeCheckOutCommand( repository, fileSet, scmVersion, recursive, shallow);
83 }
84 }