|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.plugin.util.InvolvedPluginsTracker
public class InvolvedPluginsTracker
This is a glorified list of plugin keys that code can use to track what plugins are involved in its caches
On plugin events it can then ask if the event related to one of the tracked plugins This uses aCopyOnWriteArraySet
under the covers to ensure that the list is as safe as possible. The
assumption is that the reads and writes will be of low volume and the total number of plugins tracked will be
smallish. In other words its anticipated that it will just work!
Nested Class Summary | |
---|---|
static class |
InvolvedPluginsTracker.PluginInfo
A simple class that contains plugin key and pluginVersion. |
Constructor Summary | |
---|---|
InvolvedPluginsTracker()
|
Method Summary | |
---|---|
void |
clear()
Clear the underlying set of tracked plugins |
Set<InvolvedPluginsTracker.PluginInfo> |
getInvolvedPluginKeys()
|
int |
hashCode()
The hashcode of this object will be stable so long it is tracking the same versions of the same plugins |
boolean |
isPluginInvolved(com.atlassian.plugin.ModuleDescriptor moduleDescriptor)
Returns true if the plugin that this ModuleDescriptor belongs to is being tracked |
boolean |
isPluginInvolved(com.atlassian.plugin.Plugin plugin)
Returns true if the plugin is being tracked |
boolean |
isPluginWithModuleDescriptor(com.atlassian.plugin.ModuleDescriptor moduleDescriptor,
Class<? extends com.atlassian.plugin.ModuleDescriptor> targetModuleClass)
Returns true if the plugin pointed to by the moduleDescriptor contains in it a 1 or modules with the target module descriptor class. |
boolean |
isPluginWithModuleDescriptor(com.atlassian.plugin.Plugin plugin,
Class<? extends com.atlassian.plugin.ModuleDescriptor> targetModuleClass)
Returns true if the plugin pointed to by the moduleDescriptor contains in it a 1 or module descriptors with the target module descriptor class. |
boolean |
isPluginWithResourceType(com.atlassian.plugin.ModuleDescriptor moduleDescriptor,
String pluginResourceType)
Returns true if the underlying plugin contains resources of the specified type, for example "i18n" resource types |
boolean |
isPluginWithResourceType(com.atlassian.plugin.Plugin plugin,
String pluginResourceType)
Returns true if the plugin contains resources of the specified type, for example "i18n" resource types |
String |
toString()
|
void |
trackInvolvedPlugin(com.atlassian.plugin.ModuleDescriptor moduleDescriptor)
Tracks a plugin as being involved via its ModuleDescriptor |
void |
trackInvolvedPlugin(com.atlassian.plugin.Plugin plugin)
Tracks a plugin as being involved |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public InvolvedPluginsTracker()
Method Detail |
---|
public void trackInvolvedPlugin(com.atlassian.plugin.Plugin plugin)
plugin
- the plugin in playpublic void trackInvolvedPlugin(com.atlassian.plugin.ModuleDescriptor moduleDescriptor)
ModuleDescriptor
moduleDescriptor
- the ModuleDescriptor of the plugin in playpublic boolean isPluginInvolved(com.atlassian.plugin.Plugin plugin)
plugin
- the plugin in play
public boolean isPluginInvolved(com.atlassian.plugin.ModuleDescriptor moduleDescriptor)
moduleDescriptor
- the ModuleDescriptor of the plugin in play
public boolean isPluginWithModuleDescriptor(com.atlassian.plugin.ModuleDescriptor moduleDescriptor, Class<? extends com.atlassian.plugin.ModuleDescriptor> targetModuleClass)
moduleDescriptor
- the module descriptor in play (typically from a plugin event)targetModuleClass
- the target capabilities you want to test
public boolean isPluginWithModuleDescriptor(com.atlassian.plugin.Plugin plugin, Class<? extends com.atlassian.plugin.ModuleDescriptor> targetModuleClass)
plugin
- the plugin play (typically from a plugin event)targetModuleClass
- the target capabilities you want to test
public boolean isPluginWithResourceType(com.atlassian.plugin.Plugin plugin, String pluginResourceType)
plugin
- the plugin play (typically from a plugin event)pluginResourceType
- the descriptive name of the resource type (for example "i18n")
public boolean isPluginWithResourceType(com.atlassian.plugin.ModuleDescriptor moduleDescriptor, String pluginResourceType)
moduleDescriptor
- the module descriptor of the plugin play (typically from a plugin event)pluginResourceType
- the descriptive name of the resource type (for example "i18n")
public Set<InvolvedPluginsTracker.PluginInfo> getInvolvedPluginKeys()
public void clear()
public int hashCode()
hashCode
in class Object
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |