com.powsybl.afs

Class ProjectFolder

java.lang.Object

com.powsybl.afs.AbstractNodeBase<ProjectFolder>

com.powsybl.afs.ProjectNode

com.powsybl.afs.ProjectFolder

All Implemented Interfaces:

FolderBase<ProjectNode,ProjectFolder>

public class ProjectFolder
extends ProjectNode
implements FolderBase<ProjectNode,ProjectFolder>

A folder in a Project tree.

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

Author:

Geoffroy Jamgotchian

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.ProjectNode

folder, project

Fields inherited from class com.powsybl.afs.AbstractNodeBase

codeVersion, info, storage

Constructor Summary

Constructors

Constructor and Description
ProjectFolder(ProjectFileCreationContext context)

Method Summary

Modifier and Type	Method and Description
void	addListener(ProjectFolderListener listener)
ProjectFolder	createFolder(java.lang.String name) Creates a subfolder of this folder.
<F extends ProjectFile,B extends ProjectFileBuilder<F>> B	fileBuilder(java.lang.Class<B> clazz) Gets a project file builder for type B, to build a new project file in this folder.
<T extends ProjectNode> 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<ProjectNode>	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<ProjectNode>	getChildren() Gets the list of children nodes of this project folder.
java.util.Optional<ProjectFolder>	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.
void	removeAllListeners()
void	removeListener(ProjectFolderListener listener)

Methods inherited from class com.powsybl.afs.ProjectNode

delete, getBackwardDependencies, getFileSystem, getParent, getPath, getProject, invalidate, 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

ProjectFolder

public ProjectFolder(ProjectFileCreationContext context)

Method Detail

getChildren

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

Gets the list of children nodes of this project folder.

Specified by:

getChildren in interface FolderBase<ProjectNode,ProjectFolder>

getChild

public java.util.Optional<ProjectNode> 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<ProjectNode,ProjectFolder>

getChild

public <T extends ProjectNode> 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<ProjectNode,ProjectFolder>

getFolder

public java.util.Optional<ProjectFolder> 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<ProjectNode,ProjectFolder>

createFolder

public ProjectFolder 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<ProjectNode,ProjectFolder>

fileBuilder

public <F extends ProjectFile,B extends ProjectFileBuilder<F>> B fileBuilder(java.lang.Class<B> clazz)

Gets a project file builder for type B, to build a new project file in this folder.

addListener

public void addListener(ProjectFolderListener listener)

removeListener

public void removeListener(ProjectFolderListener listener)

removeAllListeners

public void removeAllListeners()