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;
18  
19  import org.apache.commons.vfs2.FileObject;
20  
21  /**
22   * Abstracts implementations of {@link FileOperation}.
23   *
24   * @since 0.1
25   */
26  public abstract class AbstractFileOperation implements FileOperation {
27  
28      /**
29       * FileObject which the FileOperation is operated on.
30       */
31      private final FileObject fileObject;
32  
33      /**
34       * Constructs a new instance for subclasses.
35       *
36       * @param file The FileObject.
37       */
38      public AbstractFileOperation(final FileObject file) {
39          fileObject = file;
40      }
41  
42      /**
43       * Gets the instance of FileObject for this FileOperation.
44       *
45       * @return the instance of FileObject for this FileOperation.
46       */
47      protected FileObject getFileObject() {
48          return fileObject;
49      }
50  }