Change GroovyScriptExtension.load to use a map of context objects instead of a ComputationManager to be more generic #3308
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please check if the PR fulfills these requirements
Does this PR already have an issue describing the problem?
No
What kind of change does this PR introduce?
Feature
Does this PR introduce a new Powsybl Action implying to be implemented in simulators or pypowsybl?
What is the current behavior?
GroovyScriptExtension.load
expect only a ComputationManager, it is not possible to give other objects that would be used in the binding of groovy scripts.The issue was raised with a Class implemented in powsybl-metrix could not be used in a script through powsybl-afs since the binding could not be made using the GroovyScriptExtension system.
What is the new behavior (if this is a feature change)?
GroovyScriptExtension.load
now expect aMap<Class<?>, Object>
instead so that each extension implementing GroovyScriptExtension can find their specific object inside.Does this PR introduce a breaking change or deprecate an API?
If yes, please check if the following requirements are fulfilled
What changes might users need to make in their application due to this PR? (migration steps)
Classes implementing GroovyScriptExtension have to change their method
void load(Binding binding, ComputationManager computationManager)
tovoid load(Binding binding, Map<Class<?>, Object> contextObjects)
If the
computationManager
was used inside, it now has to be found in the map.See for example how the LoadFlowGroovyScriptExtension changes from:
to:
Other information: