Package ghidra.framework.plugintool
Annotation Interface PluginInfo
Information about a Ghidra
Plugin
.
Example:
@PluginInfo( status = PluginStatus.RELEASED, packageName = CorePluginPackage.NAME, category = PluginCategoryNames.COMMON, shortDescription = "Short description of plugin", description = "Longer description of plugin.", servicesProvided = { ServiceInterfaceThisPluginProvides.class } servicesRequired = { RequiredServiceInterface1.class, RequiredServiceInterface2.class }, eventsConsumed = { SomePluginEvent.class }, eventsProduced = { AnotherPluginEvent.class }, isSlowInstallation = false )
-
Required Element Summary
Modifier and TypeRequired ElementDescriptionSee PluginCategoryNamesThe long description of what the plugin does.The package name this plugin belongs in.A brief description of what the plugin does. -
Optional Element Summary
Modifier and TypeOptional ElementDescriptionClass<? extends PluginEvent>[]
List of PluginEvents (classes) that this Plugin consumes.Class<? extends PluginEvent>[]
List of PluginEvent (classes) that this Plugin produces.boolean
Signals that this plugin loads slowly.Class<?>[]
List of service interface Classes that this Plugin provides.Class<?>[]
List of service interface Classes that this Plugin requires (depends on).
-
Element Details
-
status
PluginStatus status -
packageName
String packageNameThe package name this plugin belongs in.Use XYZPluginPackage.NAME
- Returns:
- String package name
-
category
String categorySee PluginCategoryNames- PluginCategoryNames.COMMON
- PluginCategoryNames.SUPPORT
- PluginCategoryNames.etc
- Returns:
- String category
-
shortDescription
String shortDescriptionA brief description of what the plugin does.This string probably should not end with a "." character.
- Returns:
- String brief description of what the plugin does.
-
description
String descriptionThe long description of what the plugin does.This string probably should end with a "." character.
- Returns:
- String description of what the plugin does
-
isSlowInstallation
boolean isSlowInstallationSignals that this plugin loads slowly.- Returns:
- boolean
- Default:
false
-
eventsConsumed
Class<? extends PluginEvent>[] eventsConsumedList of PluginEvents (classes) that this Plugin consumes.- Returns:
- PluginEvent class list, defaults to empty.
- Default:
{}
-
eventsProduced
Class<? extends PluginEvent>[] eventsProducedList of PluginEvent (classes) that this Plugin produces.- Returns:
- PluginEvent class list, defaults to empty.
- Default:
{}
-
servicesRequired
Class<?>[] servicesRequiredList of service interface Classes that this Plugin requires (depends on).- Returns:
- List of Classes, defaults to empty.
- Default:
{}
-
servicesProvided
Class<?>[] servicesProvidedList of service interface Classes that this Plugin provides.- Returns:
- List of Classes, defaults to empty.
- Default:
{}
-