Package ghidra.framework.model
Interface ToolConnection
-
public interface ToolConnection
Represents a connection between a producer tool and a consumer tool.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
connect(java.lang.String eventName)
Connect the tools for the given event name.void
disconnect(java.lang.String eventName)
Break the connection between the tools for the given event name.PluginTool
getConsumer()
Get the tool that consumes an eventjava.lang.String[]
getEvents()
Get the list of event names that is an intersection between what the producer produces and what the consumers consumes.PluginTool
getProducer()
Get the tool that produces an eventboolean
isConnected(java.lang.String eventName)
Return whether the tools are connected for the given event name.
-
-
-
Method Detail
-
getProducer
PluginTool getProducer()
Get the tool that produces an event- Returns:
- the tool
-
getConsumer
PluginTool getConsumer()
Get the tool that consumes an event- Returns:
- the tool
-
getEvents
java.lang.String[] getEvents()
Get the list of event names that is an intersection between what the producer produces and what the consumers consumes.- Returns:
- an array of event names
-
connect
void connect(java.lang.String eventName)
Connect the tools for the given event name.- Parameters:
eventName
- name of event to connect- Throws:
java.lang.IllegalArgumentException
- if eventName is not valid for this producer/consumer pair.
-
disconnect
void disconnect(java.lang.String eventName)
Break the connection between the tools for the given event name.- Parameters:
eventName
- name of event to disconnect- Throws:
java.lang.IllegalArgumentException
- if eventName is not valid for this producer/consumer pair.
-
isConnected
boolean isConnected(java.lang.String eventName)
Return whether the tools are connected for the given event name.- Parameters:
eventName
- name of event to check- Returns:
- true if the tools are connected by eventName.
-
-