1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * with the License. You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, 13 * software distributed under the License is distributed on an 14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 * KIND, either express or implied. See the License for the 16 * specific language governing permissions and limitations 17 * under the License. 18 */ 19 package org.apache.maven.scm.command.checkout; 20 21 import org.apache.maven.scm.CommandParameter; 22 import org.apache.maven.scm.CommandParameters; 23 import org.apache.maven.scm.ScmException; 24 import org.apache.maven.scm.ScmFileSet; 25 import org.apache.maven.scm.ScmResult; 26 import org.apache.maven.scm.ScmVersion; 27 import org.apache.maven.scm.command.AbstractCommand; 28 import org.apache.maven.scm.provider.ScmProviderRepository; 29 30 /** 31 * @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a> 32 * @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a> 33 * @author Olivier Lamy 34 * 35 */ 36 public abstract class AbstractCheckOutCommand extends AbstractCommand { 37 /** 38 * Execute Check out command line in a recursive check out way. 39 * 40 * @param repository not null 41 * @param fileSet not null 42 * @param scmVersion not null 43 * @return the checkout result 44 * @throws ScmException if any 45 * @see #executeCheckOutCommand(ScmProviderRepository, ScmFileSet, ScmVersion, boolean, boolean) 46 */ 47 protected CheckOutScmResult executeCheckOutCommand( 48 ScmProviderRepository repository, ScmFileSet fileSet, ScmVersion scmVersion) throws ScmException { 49 return executeCheckOutCommand(repository, fileSet, scmVersion, true, false); 50 } 51 52 /** 53 * Execute Check out command line. 54 * 55 * @param repository not null 56 * @param fileSet not null 57 * @param scmVersion not null 58 * @param recursive <code>true</code> if recursive check out is wanted, <code>false</code> otherwise. 59 * @param shallow <code>true</code> if shallow check out is wanted, <code>false</code> otherwise. 60 * @return the checkout result 61 * @throws ScmException if any 62 * @since 1.1.1 63 */ 64 protected abstract CheckOutScmResult executeCheckOutCommand( 65 ScmProviderRepository repository, 66 ScmFileSet fileSet, 67 ScmVersion scmVersion, 68 boolean recursive, 69 boolean shallow) 70 throws ScmException; 71 72 /** {@inheritDoc} */ 73 public ScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) 74 throws ScmException { 75 ScmVersion scmVersion = parameters.getScmVersion(CommandParameter.SCM_VERSION, null); 76 boolean recursive = parameters.getBoolean(CommandParameter.RECURSIVE, true); 77 boolean shallow = parameters.getBoolean(CommandParameter.SHALLOW, false); 78 return executeCheckOutCommand(repository, fileSet, scmVersion, recursive, shallow); 79 } 80 }