Package com.powsybl.dynamicsimulation.groovy

Interface GroovyExtension<T>

All Known Subinterfaces:

CurveGroovyExtension, DynamicModelGroovyExtension, EventModelGroovyExtension

public interface GroovyExtension<T>

Author:

Mathieu Bague <[email protected]>

Method Summary

Modifier and Type	Method	Description
static <T extends GroovyExtension> List<T>	find(Class<T> clazz, String providerName)	Return the list of available GroovyExtension of type clazz, compatible with the provider which the name is given
default String	getName()	Return the name of the DynamicSimulationProvider instance, this provider is compatible with.
void	load(groovy.lang.Binding binding, Consumer<T> consumer, ReportNode reportNode)	Load the extension into the binding object.

Method Details

getName

default String getName()

Return the name of the DynamicSimulationProvider instance, this provider is compatible with. This method can return null, if this extension is compatible with any DynamicSimulationProvider objects.

Returns:

The name of a compatible DynamicSimulationProvider, or null for any

load

void load(groovy.lang.Binding binding,
 Consumer<T> consumer,
 ReportNode reportNode)

Load the extension into the binding object. Each time an object is created, the consumer is notified.

Parameters:

binding - The binding where to register the extension

consumer - The consumer to notify on objects creation

reportNode - the reportNode used for functional logs

find

static <T extends GroovyExtension> List<T> find(Class<T> clazz,
 String providerName)

Return the list of available GroovyExtension of type clazz, compatible with the provider which the name is given

Parameters:

clazz - The type of extension to look for in the classpath

providerName - The name of the provider

Returns:

A list of extensions compatible with a given provider