Package 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 aProject
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 Description static 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 Description ProjectFolder(ProjectFileCreationContext context)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addListener(ProjectFolderListener listener)
ProjectFolder
createFolder(String name)
Creates a subfolder of this folder.<F extends ProjectFile,B extends ProjectFileBuilder<F>>
BfileBuilder(Class<B> clazz)
Gets a project file builder for type B, to build a new project file in this folder.<T extends ProjectNode>
Optional<T>getChild(Class<T> clazz, String name, 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.Optional<ProjectNode>
getChild(String name, String... more)
Gets the child node at path "name/name2/..." relative to this folder, or empty if it does not exist.List<ProjectNode>
getChildren()
Gets the list of children nodes of this project folder.Optional<ProjectFolder>
getFolder(String name, 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, findService, getBackwardDependencies, getFileSystem, getParent, getPath, getProject, invalidate, isFolder
-
Methods inherited from class com.powsybl.afs.AbstractNodeBase
archive, archive, archive, archive, archive, getChildInfo, getCodeVersion, getCreationDate, getDescription, getId, getModificationDate, getName, getParentInfo, getVersion, isAheadOfVersion, isAncestorOf, moveTo, rename, setDescription, toString, unarchive, unarchive
-
-
-
-
Field Detail
-
PSEUDO_CLASS
public static final 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 List<ProjectNode> getChildren()
Gets the list of children nodes of this project folder.- Specified by:
getChildren
in interfaceFolderBase<ProjectNode,ProjectFolder>
-
getChild
public Optional<ProjectNode> getChild(String name, 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 interfaceFolderBase<ProjectNode,ProjectFolder>
-
getChild
public <T extends ProjectNode> Optional<T> getChild(Class<T> clazz, String name, 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 interfaceFolderBase<ProjectNode,ProjectFolder>
-
getFolder
public Optional<ProjectFolder> getFolder(String name, String... more)
Gets the folder at path "name/name2/..." relative to this folder, or empty if it does not exist.- Specified by:
getFolder
in interfaceFolderBase<ProjectNode,ProjectFolder>
-
createFolder
public ProjectFolder createFolder(String name)
Creates a subfolder of this folder. If a folder with same name already exists, returns the existing folder.- Specified by:
createFolder
in interfaceFolderBase<ProjectNode,ProjectFolder>
-
fileBuilder
public <F extends ProjectFile,B extends ProjectFileBuilder<F>> B fileBuilder(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()
-
-