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;
18  
19  import org.apache.commons.vfs.FileSystemException;
20  
21  /***
22   * FileOperations interface provides API to work with operations.
23   * 
24   * @see FileOperation on what a operation in the context of VFS is.
25   * 
26   * @author Siarhei Baidun
27   * @since 0.1
28   */
29  public interface FileOperations
30  {
31  	/***
32  	 * @return all operations associated with the fileObject
33  	 * @throws FileSystemException
34  	 */
35  	Class[] getOperations() throws FileSystemException;
36  
37  	/***
38  	 * @return a operation implementing the given <code>operationClass</code>
39  	 * @throws FileSystemException
40  	 */
41  	FileOperation getOperation(Class operationClass) throws FileSystemException;
42  
43  	/***
44  	 * @return if a operation <code>operationClass</code> is available
45  	 * @throws FileSystemException
46  	 */
47  	boolean hasOperation(Class operationClass) throws FileSystemException;
48  }