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.FileSystemException;
20
21 /**
22 * FileOperations interface provides API to work with operations.
23 *
24 * @see FileOperation on what an operation in the context of VFS is.
25 * @since 0.1
26 */
27 public interface FileOperations {
28
29 /**
30 * Gets the file operation for the given class.
31 *
32 * @param operationClass the operation Class.
33 * @return an operation implementing the given {@code operationClass}.
34 * @throws FileSystemException if an error occurs.
35 */
36 FileOperation getOperation(Class<? extends FileOperation> operationClass) throws FileSystemException;
37
38 /**
39 * Gets all operations associated with this instance.
40 *
41 * @return all operations associated with this instance.
42 * @throws FileSystemException if an error occurs.
43 */
44 Class<? extends FileOperation>[] getOperations() throws FileSystemException;
45
46 /**
47 * Tests @return whether an operation {@code operationClass} is available.
48 *
49 * @param operationClass the operation Class.
50 * @return whether an operation {@code operationClass} is available.
51 * @throws FileSystemException if an error occurs.
52 */
53 boolean hasOperation(Class<? extends FileOperation> operationClass) throws FileSystemException;
54 }