Package org.eclipse.serializer.afs.types

Interface AFileSystem

All Superinterfaces:

AResolving, WriteController

All Known Implementing Classes:

AFileSystem.Abstract

public interface AFileSystem
extends AResolving, WriteController

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AFileSystem.Abstract<H extends AIoHandler,D,F>

Nested classes/interfaces inherited from interface org.eclipse.serializer.afs.types.WriteController

WriteController.Disabled, WriteController.Enabled

Method Summary

Modifier and Type	Method	Description
AccessManager	accessManager()
<R> R	accessRoots(Function<? super XGettingTable<String,ADirectory>,R> logic)
boolean	addRoot(ADirectory rootDirectory)
default String	assemblePath(ADirectory directory)
VarString	assemblePath(ADirectory directory, VarString vs)
default String	assemblePath(AFile file)
VarString	assemblePath(AFile file, VarString vs)
default String[]	buildPath(ADirectory directory)
default String[]	buildPath(AFile file)
String[]	buildPath(AItem item)
AReadableFile	convertToReading(AWritableFile file)
AWritableFile	convertToWriting(AReadableFile file)
ACreator	creator()
String	defaultProtocol()
String	deriveFileIdentifier(String fileName, String fileType)
String	deriveFileName(String fileIdentifier)
String	deriveFileType(String fileIdentifier)
ADirectory	ensureDefaultRoot()	Ensures the default root directory.
default ADirectory	ensureDirectoryPath(String... pathElements)
ADirectory	ensureDirectoryPath(String[] pathElements, int offset, int length)
default AFile	ensureFilePath(String... pathElements)
AFile	ensureFilePath(String[] directoryPathElements, int offset, int length, String fileIdentifier)
default AFile	ensureFilePath(String[] directoryPathElements, String fileIdentifier)
ADirectory	ensureRoot(String identifier)
ADirectory	ensureRoot(ARoot.Creator rootCreator, String identifier)
String	getFileName(AFile file)
String	getFileType(AFile file)
ADirectory	getRoot(String identifier)
AIoHandler	ioHandler()
ADirectory	lookupRoot(String identifier)
ADirectory	removeRoot(String identifier)
boolean	removeRoot(ADirectory rootDirectory)
<I extends AItem> I	validateMember(I item)
AReadableFile	wrapForReading(AFile file, Object user)
AWritableFile	wrapForWriting(AFile file, Object user)

Methods inherited from interface org.eclipse.serializer.afs.types.AResolving

resolveDirectoryPath, resolveDirectoryPath, resolveFilePath, resolveFilePath, resolveFilePath

Methods inherited from interface org.eclipse.serializer.afs.types.WriteController

isWritable, validateIsWritable

Method Detail

defaultProtocol

String defaultProtocol()

ensureDirectoryPath

default ADirectory ensureDirectoryPath(String... pathElements)

ensureDirectoryPath

ADirectory ensureDirectoryPath(String[] pathElements,
                               int offset,
                               int length)

ensureFilePath

default AFile ensureFilePath(String... pathElements)

ensureFilePath

default AFile ensureFilePath(String[] directoryPathElements,
                             String fileIdentifier)

ensureFilePath

AFile ensureFilePath(String[] directoryPathElements,
                     int offset,
                     int length,
                     String fileIdentifier)

accessManager

AccessManager accessManager()

creator

ACreator creator()

ioHandler

AIoHandler ioHandler()

wrapForReading

AReadableFile wrapForReading(AFile file,
                             Object user)

wrapForWriting

AWritableFile wrapForWriting(AFile file,
                             Object user)

convertToReading

AReadableFile convertToReading(AWritableFile file)

convertToWriting

AWritableFile convertToWriting(AReadableFile file)

lookupRoot

ADirectory lookupRoot(String identifier)

getRoot

ADirectory getRoot(String identifier)

ensureRoot

ADirectory ensureRoot(String identifier)

ensureRoot

ADirectory ensureRoot(ARoot.Creator rootCreator,
                      String identifier)

ensureDefaultRoot

ADirectory ensureDefaultRoot()

Ensures the default root directory. May not be supported by different file system implementations.

Returns:

the root directory

Throws:

UnsupportedOperationException - if the file system doesn't have a default root

removeRoot

ADirectory removeRoot(String identifier)

addRoot

boolean addRoot(ADirectory rootDirectory)

removeRoot

boolean removeRoot(ADirectory rootDirectory)

accessRoots

<R> R accessRoots(Function<? super XGettingTable<String,ADirectory>,R> logic)

validateMember

<I extends AItem> I validateMember(I item)

assemblePath

default String assemblePath(AFile file)

assemblePath

default String assemblePath(ADirectory directory)

deriveFileIdentifier

String deriveFileIdentifier(String fileName,
                            String fileType)

deriveFileName

String deriveFileName(String fileIdentifier)

deriveFileType

String deriveFileType(String fileIdentifier)

assemblePath

VarString assemblePath(AFile file,
                       VarString vs)

assemblePath

VarString assemblePath(ADirectory directory,
                       VarString vs)

buildPath

String[] buildPath(AItem item)

buildPath

default String[] buildPath(AFile file)

buildPath

default String[] buildPath(ADirectory directory)

getFileName

String getFileName(AFile file)

getFileType

String getFileType(AFile file)