001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.vfs2.operations.vcs;
018
019import org.apache.commons.vfs2.FileObject;
020import org.apache.commons.vfs2.operations.FileOperation;
021
022/**
023 * The VCS checkout file operation.
024 *
025 * @since 0.1
026 */
027public interface VcsCheckout extends FileOperation {
028
029    /**
030     * Sets whether administrative .svn directories will not be created on the retrieved tree. The checkout operation in this case is equivalent to export
031     * function.
032     *
033     * @param export if true, administrative .svn directories will not be created on the retrieved tree.
034     */
035    void setExport(boolean export);
036
037    /**
038     * Sets whether directories should be traversed.
039     *
040     * @param recursive true if directories should be traversed.
041     */
042    void setRecursive(boolean recursive);
043
044    /**
045     * Sets the revision number.
046     *
047     * @param revision The revision number.
048     */
049    void setRevision(long revision);
050
051    /**
052     * Sets directory under which retrieved files should be placed.
053     *
054     * @param targetDir directory under which retrieved files should be placed.
055     */
056    void setTargetDirectory(FileObject targetDir);
057}