com.powsybl.afs

Interface ProjectFileExtension<T extends ProjectFile,U extends ProjectFileBuilder<T>>

All Known Implementing Classes:

ActionScriptExtension, ContingencyStoreExtension, ImportedCaseExtension, ModificationScriptExtension, SecurityAnalysisRunnerExtension, VirtualCaseExtension

public interface ProjectFileExtension<T extends ProjectFile,U extends ProjectFileBuilder<T>>

Interface to add a new type of project file to the application file system.

In order to add a new type of project file to your AppData instance, you need to implement that interface and declare it to the runtime using the AutoService annotation.

The instance needs to define the new class, a name identifying that class ("pseudo class"), and to provide a builder object to create an actual instance of the new class. For instance:

       @AutoService(ProjectFileExtension.class)
      public class FooFileExtension implements ProjectFileExtension {

       @Override
      public Class getProjectFileClass() {
          return FooFile.class;
      }

       @Override
      public String getProjectFilePseudoClass() {
          return "foo";
      }

       @Override
      public Class getProjectFileBuilderClass() {
          return FooFileBuilder.class;
      }

       @Override
      public FooFile createProjectFile(ProjectFileCreationContext context) {
          return new FooFile(context);
      }

       @Override
      public FooFileBuilder createProjectFileBuilder(ProjectFileBuildContext context) {
          return new FooFileBuilder(context);
      }
  }
 

Author:

Geoffroy Jamgotchian

Method Summary

Modifier and Type	Method and Description
T	createProjectFile(ProjectFileCreationContext context) Creates an object with default constructor.
ProjectFileBuilder<T>	createProjectFileBuilder(ProjectFileBuildContext context) Creates a builder object, to build an instance of the new type with additional parameters passed to the builder.
java.lang.Class<U>	getProjectFileBuilderClass() The builder class for the new type.
java.lang.Class<T>	getProjectFileClass() The new project file type to be injected.
java.lang.String	getProjectFilePseudoClass() A "pseudo class" name for the new type.

Method Detail

getProjectFileClass

java.lang.Class<T> getProjectFileClass()

The new project file type to be injected.

getProjectFilePseudoClass

java.lang.String getProjectFilePseudoClass()

A "pseudo class" name for the new type.

getProjectFileBuilderClass

java.lang.Class<U> getProjectFileBuilderClass()

The builder class for the new type. Builders will be in charge of creating actual instances of the new type.

createProjectFile

T createProjectFile(ProjectFileCreationContext context)

Creates an object with default constructor.

createProjectFileBuilder

ProjectFileBuilder<T> createProjectFileBuilder(ProjectFileBuildContext context)

Creates a builder object, to build an instance of the new type with additional parameters passed to the builder.