org.azyva.dragom.execcontext.plugin

Interface RuntimePropertiesPlugin

All Superinterfaces:

ExecContextPlugin

public interface RuntimePropertiesPlugin
extends ExecContextPlugin

Provides runtime properties during the execution of tools.

Modifications to runtime properties are not meant to be persisted across tool executions. If a tool needs to manage persistent properties, it should explicitly use ExecContext.getProperty(java.lang.String) and ExecContext.setProperty(java.lang.String, java.lang.String) or other means.

Author:

David Raymond

Method Summary

Modifier and Type	Method and Description
String	getProperty(Node node, String name) Gets the value of a property associated with a node.
void	setProperty(Node node, String name, String value) Sets the value of a property associated with a node.

Method Detail

getProperty

String getProperty(Node node,
                   String name)

Gets the value of a property associated with a node.

It is up to the plugin implementation to use the appropriate property resolution algorithm. Such an algorithm can involve:

• Evaluating the property as an expression
• Using the properties of the Node as default values for RuntimeProperties that may not be explicitly defined
• Implementing property inheritance

Parameters:

node - Node in the context of which the property is requested. May be null as equivalent to specifying the Model root Node.

name - Name of the property.

Returns:

Value of the property. null if no such property.

setProperty

void setProperty(Node node,
                 String name,
                 String value)

Sets the value of a property associated with a node.

Properties sets in this way are expected to take precedence.

Parameters:

node - Node in the context of which the property is set. May be null as equivalent to specifying the Model root Node.

name - Name of the property.

value - Value of the property.