001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.vfs2.operations;
018
019import org.apache.commons.vfs2.FileSystemException;
020
021/**
022 * FileOperations interface provides API to work with operations.
023 *
024 * @see FileOperation on what an operation in the context of VFS is.
025 * @since 0.1
026 */
027public interface FileOperations {
028
029    /**
030     * Gets the file operation for the given class.
031     *
032     * @param operationClass the operation Class.
033     * @return an operation implementing the given {@code operationClass}.
034     * @throws FileSystemException if an error occurs.
035     */
036    FileOperation getOperation(Class<? extends FileOperation> operationClass) throws FileSystemException;
037
038    /**
039     * Gets all operations associated with this instance.
040     *
041     * @return all operations associated with this instance.
042     * @throws FileSystemException if an error occurs.
043     */
044    Class<? extends FileOperation>[] getOperations() throws FileSystemException;
045
046    /**
047     * Tests @return whether an operation {@code operationClass} is available.
048     *
049     * @param operationClass the operation Class.
050     * @return whether an operation {@code operationClass} is available.
051     * @throws FileSystemException if an error occurs.
052     */
053    boolean hasOperation(Class<? extends FileOperation> operationClass) throws FileSystemException;
054}