1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one or more 3 * contributor license agreements. See the NOTICE file distributed with 4 * this work for additional information regarding copyright ownership. 5 * The ASF licenses this file to You under the Apache License, Version 2.0 6 * (the "License"); you may not use this file except in compliance with 7 * the License. You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 */ 17 package org.apache.commons.vfs2.operations.vcs; 18 19 import org.apache.commons.vfs2.FileObject; 20 import org.apache.commons.vfs2.operations.FileOperation; 21 22 /** 23 * The VCS checkout file operation. 24 * 25 * @since 0.1 26 */ 27 public interface VcsCheckout extends FileOperation { 28 29 /** 30 * Sets whether administrative .svn directories will not be created on the retrieved tree. The checkout operation in this case is equivalent to export 31 * function. 32 * 33 * @param export if true, administrative .svn directories will not be created on the retrieved tree. 34 */ 35 void setExport(boolean export); 36 37 /** 38 * Sets whether directories should be traversed. 39 * 40 * @param recursive true if directories should be traversed. 41 */ 42 void setRecursive(boolean recursive); 43 44 /** 45 * Sets the revision number. 46 * 47 * @param revision The revision number. 48 */ 49 void setRevision(long revision); 50 51 /** 52 * Sets directory under which retrieved files should be placed. 53 * 54 * @param targetDir directory under which retrieved files should be placed. 55 */ 56 void setTargetDirectory(FileObject targetDir); 57 }