de.pfabulist.lindwurm.eighty

Interface EightyFS

public interface EightyFS

EightFs is an interface that helps implement NIO2 filesystems

the methods can assume that all Path arguments are from this filesystem and absolute

Method Summary

Modifier and Type	Method and Description
void	checkAccess(EightyPath path, AccessMode... modes) Check Read, Write, Exec access is called quite often for file existence
default void	copy(EightyPath source, EightyPath target, CopyOption... options) Copy with same provider (not necessarily same FS) target does not exist needs to send out watch events (if supported in FS)
void	createDirectory(EightyPath dir, FileAttribute<?>... attrs) Create a new Directory This method should work in the manner specified in the Files.createDirectory(java.nio.file.Path, java.nio.file.attribute.FileAttribute<?>...) method.
default void	createHardLink(EightyPath normLink, EightyPath normExisting)
default void	createSymLink(EightyPath link, EightyPath existing, FileAttribute<?>[] attrs)
void	delete(EightyPath path) Deletes the path as in Files.move(java.nio.file.Path, java.nio.file.Path, java.nio.file.CopyOption...) but - path is absolute - is non empty - exists - is not root
<V extends FileAttributeView> V	getFileAttributeView(EightyPath path, Class<V> type)
default FileStore	getFileStore(EightyPath path)
default Iterable<FileStore>	getFileStores()
default PathConstraints	getPathConstraints()
default Optional<EightySymLink>	getSymlink(EightyPath path)
default UserPrincipalLookupService	getUserPrincipalLookupService()
default boolean	isClosable()
default boolean	isHidden(EightyPath paths)
default boolean	isReadOnly()
default boolean	isReopenable()
default void	move(EightyPath source, EightyPath target) Moves the content of source to path This method works in mostly the manner specified by the Files.move(java.nio.file.Path, java.nio.file.Path, java.nio.file.CopyOption...) method.
default SeekableByteChannel	newByteChannel(EightyPath path, Set<? extends OpenOption> options, FileAttribute<?>... attrs)
default void	newContent(EightyPath path)
Stream<Path>	newDirectoryStream(EightyPath dir)
FileChannel	newFileChannel(EightyPath path, Set<? extends OpenOption> options, FileAttribute<?>... attrs) Creates new SeekableByteChannel to that path This method works in mostly the manner specified by the Files.newByteChannel(java.nio.file.Path, java.util.Set<? extends java.nio.file.OpenOption>, java.nio.file.attribute.FileAttribute<?>...) method.
default void	onClose()
default void	reopen()
default void	setReadOnly(boolean readOnly)
default void	setWatcher(EightyWatcher eightyFileSystem)
default boolean	supportsSymlinks()
default boolean	watchable()

Method Detail

newFileChannel

FileChannel newFileChannel(EightyPath path,
                           Set<? extends OpenOption> options,
                           FileAttribute<?>... attrs)

Creates new SeekableByteChannel to that path This method works in mostly the manner specified by the Files.newByteChannel(java.nio.file.Path, java.util.Set<? extends java.nio.file.OpenOption>, java.nio.file.attribute.FileAttribute<?>...) method.

Differences to the general method: - The set of options is not empty - APPEND and READ are not both in the options - IF the file does not exist than WRITE and either CREATE or CREATE_NEW are in the options - If READ and no Create variants are in the options than the file exists - The path is not a directory - The path is absolute, normalized and has no sym link in its path - The channel needs to implement InformativeClosable - Parent path exists and is a directory

Parameters:

path - An absolute path of a filesystem of this provider

options - A non empty set of options without any conflicts, see above

attrs - attributes

Returns:

newByteChannel

default SeekableByteChannel newByteChannel(EightyPath path,
                                           Set<? extends OpenOption> options,
                                           FileAttribute<?>... attrs)

createDirectory

void createDirectory(EightyPath dir,
                     FileAttribute<?>... attrs)

Create a new Directory This method should work in the manner specified in the Files.createDirectory(java.nio.file.Path, java.nio.file.attribute.FileAttribute<?>...) method.

Differences are - dir is absolute - dirs parent is a dir and exists - dir does not exist

Parameters:

dir -

attrs -

checkAccess

void checkAccess(EightyPath path,
                 AccessMode... modes)

Check Read, Write, Exec access is called quite often for file existence

newDirectoryStream

Stream<Path> newDirectoryStream(EightyPath dir)

copy

default void copy(EightyPath source,
                  EightyPath target,
                  CopyOption... options)

Copy with same provider (not necessarily same FS) target does not exist needs to send out watch events (if supported in FS)

Parameters:

source -

target -

options -

move

default void move(EightyPath source,
                  EightyPath target)

Moves the content of source to path This method works in mostly the manner specified by the Files.move(java.nio.file.Path, java.nio.file.Path, java.nio.file.CopyOption...) method. but: source and target are absolute paths of the same filesystem source path is sym link free target does not exist target parent does exist

Parameters:

source -

target -

delete

void delete(EightyPath path)

Deletes the path as in Files.move(java.nio.file.Path, java.nio.file.Path, java.nio.file.CopyOption...) but - path is absolute - is non empty - exists - is not root

Parameters:

path -

getFileStore

default FileStore getFileStore(EightyPath path)

getFileStores

default Iterable<FileStore> getFileStores()

getFileAttributeView

<V extends FileAttributeView> V getFileAttributeView(EightyPath path,
                                                     Class<V> type)

Type Parameters:

V -

Parameters:

path -

type - A supported FileAttributeView

Returns:

isReadOnly

default boolean isReadOnly()

setReadOnly

default void setReadOnly(boolean readOnly)

isHidden

default boolean isHidden(EightyPath paths)

isClosable

default boolean isClosable()

watchable

default boolean watchable()

isReopenable

default boolean isReopenable()

reopen

default void reopen()

setWatcher

default void setWatcher(EightyWatcher eightyFileSystem)

createHardLink

default void createHardLink(EightyPath normLink,
                            EightyPath normExisting)

createSymLink

default void createSymLink(EightyPath link,
                           EightyPath existing,
                           FileAttribute<?>[] attrs)

getSymlink

default Optional<EightySymLink> getSymlink(EightyPath path)

supportsSymlinks

default boolean supportsSymlinks()

onClose

default void onClose()

getUserPrincipalLookupService

default UserPrincipalLookupService getUserPrincipalLookupService()

getPathConstraints

default PathConstraints getPathConstraints()

newContent

default void newContent(EightyPath path)