org.uberfire.java.nio.file.spi.FileSystemProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of uberfire-nio2-model Show documentation
Uberfire NIO.2 :: Model
There is a newer version: 2.5.0.Final
/*
 * Copyright 2015 Red Hat, Inc. and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.uberfire.java.nio.file.spi;

import java.io.InputStream;
import java.io.OutputStream;
import java.net.URI;
import java.nio.channels.FileChannel;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ExecutorService;

import org.uberfire.java.nio.IOException;
import org.uberfire.java.nio.channels.AsynchronousFileChannel;
import org.uberfire.java.nio.channels.SeekableByteChannel;
import org.uberfire.java.nio.file.AccessDeniedException;
import org.uberfire.java.nio.file.AccessMode;
import org.uberfire.java.nio.file.AtomicMoveNotSupportedException;
import org.uberfire.java.nio.file.CopyOption;
import org.uberfire.java.nio.file.DeleteOption;
import org.uberfire.java.nio.file.DirectoryNotEmptyException;
import org.uberfire.java.nio.file.DirectoryStream;
import org.uberfire.java.nio.file.FileAlreadyExistsException;
import org.uberfire.java.nio.file.FileStore;
import org.uberfire.java.nio.file.FileSystem;
import org.uberfire.java.nio.file.FileSystemAlreadyExistsException;
import org.uberfire.java.nio.file.FileSystemNotFoundException;
import org.uberfire.java.nio.file.LinkOption;
import org.uberfire.java.nio.file.NoSuchFileException;
import org.uberfire.java.nio.file.NotDirectoryException;
import org.uberfire.java.nio.file.NotLinkException;
import org.uberfire.java.nio.file.OpenOption;
import org.uberfire.java.nio.file.Path;
import org.uberfire.java.nio.file.attribute.BasicFileAttributes;
import org.uberfire.java.nio.file.attribute.FileAttribute;
import org.uberfire.java.nio.file.attribute.FileAttributeView;

/**
 * Back port of JSR-203 from Java Platform, Standard Edition 7.
 * @see Original JavaDoc
 */
public interface FileSystemProvider {

    void forceAsDefault();

    boolean isDefault();

    String getScheme();

    FileSystem newFileSystem( URI uri,
                              Map env )
            throws IllegalArgumentException, IOException, SecurityException, FileSystemAlreadyExistsException;

    FileSystem getFileSystem( URI uri )
            throws IllegalArgumentException, FileSystemNotFoundException, SecurityException;

    Path getPath( URI uri )
            throws IllegalArgumentException, FileSystemNotFoundException, SecurityException;

    FileSystem newFileSystem( Path path,
                              Map env )
            throws IllegalArgumentException, UnsupportedOperationException, IOException, SecurityException;

    InputStream newInputStream( final Path path,
                                final OpenOption... options )
            throws IllegalArgumentException, UnsupportedOperationException, NoSuchFileException, IOException, SecurityException;

    OutputStream newOutputStream( Path path,
                                  OpenOption... options )
            throws IllegalArgumentException, UnsupportedOperationException, IOException, SecurityException;

    FileChannel newFileChannel( Path path,
                                Set options,
                                FileAttribute... attrs )
            throws IllegalArgumentException, UnsupportedOperationException, IOException, SecurityException;

    AsynchronousFileChannel newAsynchronousFileChannel( Path path,
                                                        Set options,
                                                        ExecutorService executor,
                                                        FileAttribute... attrs )
            throws IllegalArgumentException, UnsupportedOperationException, IOException, SecurityException;

    SeekableByteChannel newByteChannel( Path path,
                                        Set options,
                                        FileAttribute... attrs )
            throws IllegalArgumentException, UnsupportedOperationException, FileAlreadyExistsException, IOException, SecurityException;

    DirectoryStream newDirectoryStream( Path dir,
                                              DirectoryStream.Filter filter )
            throws NotDirectoryException, IOException, SecurityException;

    void createDirectory( Path dir,
                          FileAttribute... attrs )
            throws UnsupportedOperationException, FileAlreadyExistsException, IOException, SecurityException;

    void createSymbolicLink( Path link,
                             Path target,
                             FileAttribute... attrs )
            throws UnsupportedOperationException, FileAlreadyExistsException, IOException, SecurityException;

    void createLink( Path link,
                     Path existing )
            throws UnsupportedOperationException, FileAlreadyExistsException, IOException, SecurityException;

    void delete( Path path,
                 DeleteOption... options )
            throws DirectoryNotEmptyException, NoSuchFileException, IOException, SecurityException;

    boolean deleteIfExists( Path path,
                            DeleteOption... options )
            throws DirectoryNotEmptyException, IOException, SecurityException;

    Path readSymbolicLink( Path link )
            throws UnsupportedOperationException, NotLinkException, IOException, SecurityException;

    void copy( Path source,
               Path target,
               CopyOption... options )
            throws UnsupportedOperationException, FileAlreadyExistsException, DirectoryNotEmptyException,
            IOException, SecurityException;

    void move( Path source,
               Path target,
               CopyOption... options )
            throws DirectoryNotEmptyException, AtomicMoveNotSupportedException, IOException, SecurityException;

    boolean isSameFile( Path path,
                        Path path2 )
            throws IOException, SecurityException;

    boolean isHidden( Path path )
            throws IllegalArgumentException, IOException, SecurityException;

    FileStore getFileStore( Path path )
            throws IOException, SecurityException;

    void checkAccess( Path path,
                      AccessMode... modes )
            throws UnsupportedOperationException, NoSuchFileException, AccessDeniedException, IOException, SecurityException;

     V getFileAttributeView( Path path,
                                                          Class type,
                                                          LinkOption... options )
            throws NoSuchFileException;

     A readAttributes( Path path,
                                                      Class type,
                                                      LinkOption... options )
            throws NoSuchFileException, UnsupportedOperationException, IOException, SecurityException;

    Map readAttributes( Path path,
                                        String attributes,
                                        LinkOption... options )
            throws UnsupportedOperationException, IllegalArgumentException, IOException, SecurityException;

    void setAttribute( Path path,
                       String attribute,
                       Object value,
                       LinkOption... options )
            throws UnsupportedOperationException, IllegalArgumentException, ClassCastException, IOException, SecurityException;

}