com.github.sbaudoin.sonar.plugins.shellcheck.util

Class FileSystem

java.lang.Object

com.github.sbaudoin.sonar.plugins.shellcheck.util.FileSystem

All Implemented Interfaces:

Closeable, AutoCloseable

public final class FileSystem
extends Object
implements Closeable

A class used to make the default FileSystem be closable like the other file systems without raising an exception

Constructor Summary

Constructors

Constructor and Description
FileSystem(URI uri) Initializes a new file system connected to the passed resource

Method Summary

Modifier and Type	Method and Description
void	close()
Stream<Path>	readDirectory(URI uri) Reads and returns the 1st-level content of the passed directory described as a URI.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileSystem

public FileSystem(URI uri)

Initializes a new file system connected to the passed resource

Parameters:

uri - the URI to locate the file system

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

readDirectory

public Stream<Path> readDirectory(URI uri)
                           throws IOException

Reads and returns the 1st-level content of the passed directory described as a URI. This URI must be compatible with the file system.

Parameters:

uri - an URI to a directory

Returns:

returns the 1st-level content of the passed directory described as a URI

Throws:

IOException - if an I/O error occurs

NotDirectoryException - if the file could not otherwise be opened because it is not a directory (optional specific exception)

SecurityException - In the case the default provider is used, and a security manager is installed, the checkRead method is invoked to check read access to the directory.