com.powsybl.afs

Class Folder

java.lang.Object

com.powsybl.afs.AbstractNodeBase<Folder>

com.powsybl.afs.Node

com.powsybl.afs.Folder

All Implemented Interfaces:

FolderBase<Node,Folder>

public class Folder
extends Node
implements FolderBase<Node,Folder>

A folder in an AppFileSystem tree.

Folders may have children folders or files, and provides methods to create new children.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PSEUDO_CLASS
static int	VERSION

Fields inherited from class com.powsybl.afs.Node

fileSystem, folder

Fields inherited from class com.powsybl.afs.AbstractNodeBase

codeVersion, info, storage

Constructor Summary

Constructors

Constructor and Description
Folder(FileCreationContext context)

Method Summary

Modifier and Type	Method and Description
void	archive(java.nio.file.Path dir)
Folder	createFolder(java.lang.String name) Creates a subfolder of this folder.
Project	createProject(java.lang.String name) Creates a new Project in this folder.
void	delete()
<T extends Node> java.util.Optional<T>	getChild(java.lang.Class<T> clazz, java.lang.String name, java.lang.String... more) Gets the child node of class T at path "name/name2/..." relative to this folder, in a typesafe way, or empty if it does not exist.
java.util.Optional<Node>	getChild(java.lang.String name, java.lang.String... more) Gets the child node at path "name/name2/..." relative to this folder, or empty if it does not exist.
java.util.List<Node>	getChildren() Get the children nodes of this folder.
java.util.Optional<Folder>	getFolder(java.lang.String name, java.lang.String... more) Gets the folder at path "name/name2/..." relative to this folder, or empty if it does not exist.
boolean	isWritable()
void	unarchive(java.nio.file.Path dir)

Methods inherited from class com.powsybl.afs.Node

getFileSystem, getParent, getPath, isFolder

Methods inherited from class com.powsybl.afs.AbstractNodeBase

getChildInfo, getCodeVersion, getCreationDate, getDescription, getId, getModificationDate, getName, getParentInfo, getVersion, isAheadOfVersion, isAncestorOf, moveTo, rename, setDescription, toString

Methods inherited from class java.lang.Object

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

Field Detail

PSEUDO_CLASS

public static final java.lang.String PSEUDO_CLASS

See Also:

Constant Field Values

VERSION

public static final int VERSION

See Also:

Constant Field Values

Constructor Detail

Folder

public Folder(FileCreationContext context)

Method Detail

isWritable

public boolean isWritable()

getChildren

public java.util.List<Node> getChildren()

Get the children nodes of this folder.

Specified by:

getChildren in interface FolderBase<Node,Folder>

getChild

public java.util.Optional<Node> getChild(java.lang.String name,
                                         java.lang.String... more)

Gets the child node at path "name/name2/..." relative to this folder, or empty if it does not exist.

Specified by:

getChild in interface FolderBase<Node,Folder>

getChild

public <T extends Node> java.util.Optional<T> getChild(java.lang.Class<T> clazz,
                                                       java.lang.String name,
                                                       java.lang.String... more)

Gets the child node of class T at path "name/name2/..." relative to this folder, in a typesafe way, or empty if it does not exist.

Specified by:

getChild in interface FolderBase<Node,Folder>

getFolder

public java.util.Optional<Folder> getFolder(java.lang.String name,
                                            java.lang.String... more)

Gets the folder at path "name/name2/..." relative to this folder, or empty if it does not exist.

Specified by:

getFolder in interface FolderBase<Node,Folder>

createFolder

public Folder createFolder(java.lang.String name)

Creates a subfolder of this folder. If a folder with same name already exists, returns the existing folder.

Specified by:

createFolder in interface FolderBase<Node,Folder>

createProject

public Project createProject(java.lang.String name)

Creates a new Project in this folder. If a project with same name already exists, returns the existing project.

archive

public void archive(java.nio.file.Path dir)

unarchive

public void unarchive(java.nio.file.Path dir)

delete

public void delete()

Overrides:

delete in class Node