01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * 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.FileObject;
20: import org.apache.commons.vfs.FileSystemException;
21:
22: import java.util.Collection;
23:
24: /**
25: * FileOperationProvider is responsible for dealing with FileOperation's.
26: *
27: * @author Siarhei Baidun
28: * @since 0.1
29: */
30: public interface FileOperationProvider {
31:
32: /**
33: * Gather available operations for the specified FileObject and put them into
34: * specified operationsList.
35: *
36: * @param operationsList
37: * the list of available operations for the specivied FileObject.
38: * The operationList contains classes of available operations, e.g.
39: * Class objects.
40: * @param file
41: * the FileObject for which we want to get the list of available
42: * operations.
43: *
44: * @throws FileSystemException
45: * if list of operations cannto be retrieved.
46: */
47: void collectOperations(final Collection operationsList,
48: final FileObject file) throws FileSystemException;
49:
50: /**
51: *
52: * @param file
53: * the FileObject for which we need a operation.
54: * @param operationClass
55: * the Class which instance we are needed.
56: * @return the requried operation instance. s
57: * @throws FileSystemException
58: * if operation cannot be retrieved.
59: */
60: FileOperation getOperation(final FileObject file,
61: final Class operationClass) throws FileSystemException;
62: }
|