com.powsybl.afs

Class AppFileSystem

java.lang.Object

com.powsybl.afs.AppFileSystem

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

LocalAppFileSystem, MapDbAppFileSystem

public class AppFileSystem
extends java.lang.Object
implements java.lang.AutoCloseable

An AppFileSystem instance is a tree of Node objects, starting with its root folder.

Node objects may be Folders or File, or any new file type added by the user through the extension mechanism (see FileExtension). An application may have several instances of AppFileSystem, each one with a unique name. They are accessed through the parent AppData instance.

The AppFileSystem is backed by an AppStorage implementation, which is in charge of maintaining the state of data of the AppFileSystem. The implementation may bring additional functionalities: in-memory storage, database storage, remote storage, ...

Users of an AppFileSystem should not need to interact directly with the underlying AppStorage.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FS_SEPARATOR
static java.lang.String	PATH_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
AppFileSystem(java.lang.String name, boolean remotelyAccessible, AppStorage storage)
AppFileSystem(java.lang.String name, boolean remotelyAccessible, ListenableAppStorage storage, TaskMonitor taskMonitor)

Method Summary

Modifier and Type	Method and Description
void	close()
Node	createNode(NodeInfo nodeInfo) Creates a new Node in this file system.
<T extends ProjectFile> T	findProjectFile(java.lang.String projectFileId, java.lang.Class<T> clazz) Get a project file by its ID.
AppData	getData()
java.lang.String	getName()
Folder	getRootFolder()
TaskMonitor	getTaskMonitor()
boolean	isClosed()
boolean	isRemotelyAccessible()

Methods inherited from class java.lang.Object

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

Field Detail

FS_SEPARATOR

public static final java.lang.String FS_SEPARATOR

See Also:

Constant Field Values

PATH_SEPARATOR

public static final java.lang.String PATH_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

AppFileSystem

public AppFileSystem(java.lang.String name,
                     boolean remotelyAccessible,
                     AppStorage storage)

AppFileSystem

public AppFileSystem(java.lang.String name,
                     boolean remotelyAccessible,
                     ListenableAppStorage storage,
                     TaskMonitor taskMonitor)

Method Detail

getName

public java.lang.String getName()

isRemotelyAccessible

public boolean isRemotelyAccessible()

getRootFolder

public Folder getRootFolder()

createNode

public Node createNode(NodeInfo nodeInfo)

Creates a new Node in this file system. This is a low level method, and should seldom be used by the AFS API users.

findProjectFile

public <T extends ProjectFile> T findProjectFile(java.lang.String projectFileId,
                                                 java.lang.Class<T> clazz)

Get a project file by its ID.

getTaskMonitor

public TaskMonitor getTaskMonitor()

getData

public AppData getData()

isClosed

public boolean isClosed()

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable