View Javadoc

    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.vfs.operations.vcs;
    18
    19  import org.apache.commons.vfs.operations.FileOperation;
    20  import org.apache.commons.vfs.FileObject;
    21
    22  /***
    23   * todo: add class description here
    24   *
    25   * @author Siarhei Baidun
    26   * @since 0.1
    27   */
    28  public interface VcsCheckout extends FileOperation
    29  {
    30  	/***
    31  	 *
    32  	 * @param revision
    33  	 */
    34  	void setRevision(final long revision);
    35
    36  	/***
    37  	 *
    38  	 * @param recursive
    39  	 */
    40  	void setRecursive(final boolean recursive);
    41
    42  	/***
    43  	 *
    44  	 * @param targetDir
    45  	 *            directory under which retrieved files should be placed.
    46  	 */
    47  	void setTargetDirectory(final FileObject targetDir);
    48
    49  	/***
    50  	 * @param export
    51  	 *            if true, administrative .svn directoies will not be created on
    52  	 *            the retrieved tree. The checkout operation in this case is
    53  	 *            equivalent to export function.
    54  	 */
    55  	void setExport(final boolean export);
    56  }