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