Package com.atlassian.bitbucket.codeinsights.coverage

Class CodeCoverageProviderModuleDescriptor

java.lang.Object

com.atlassian.plugin.descriptors.AbstractModuleDescriptor<CodeCoverageProvider>

com.atlassian.bitbucket.codeinsights.coverage.CodeCoverageProviderModuleDescriptor

All Implemented Interfaces:

com.atlassian.plugin.ModuleDescriptor<CodeCoverageProvider>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware

public class CodeCoverageProviderModuleDescriptor
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<CodeCoverageProvider>

Module descriptor for providing CodeCoverageProvider implementations.

Usage:

     <code-coverage-provider key="example-code-coverage-provider" name="Example Code Coverage Provider"
              class="com.example.stash.SomethingThatExtendsTheProviderInterface">
          <description key="example.code.coverage.provider.description">Provides Code Coverage Report</description>
     </code-coverage-provider>
 

The key and class attributes are required. The name attribute and description element are optional.

• key: a key identifying the CodeCoverageProvider being registered
• name: (optional) the name of the CodeCoverageProvider being registered
• class: the class of the provider. It must be either a class which extends CodeCoverageProvider or a bean using the bean:beanName notation.
• description: (optional) an i18n key and/or message describing the coverage provided by the CodeCoverageProvider

Since:

6.8

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XML_ELEMENT_NAME

Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources

Constructor Summary

Constructors

Constructor	Description
CodeCoverageProviderModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Summary

Modifier and Type	Method	Description
void	disabled()
void	enabled()
CodeCoverageProvider	getModule()
protected void	validate(com.atlassian.plugin.module.Element element)

Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

assertModuleClassImplements, checkPermissions, destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceLocation, getScopeKey, hashCode, init, isBroken, isEnabled, isEnabledByDefault, isSystemModule, loadClass, satisfiesMinJavaVersion, setBroken, setPlugin, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

getDisplayName

Field Details

XML_ELEMENT_NAME

public static final String XML_ELEMENT_NAME

See Also:

• Constant Field Values

Constructor Details

CodeCoverageProviderModuleDescriptor

public CodeCoverageProviderModuleDescriptor(@Nonnull
 com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Details

getModule

public CodeCoverageProvider getModule()

Specified by:

getModule in interface com.atlassian.plugin.ModuleDescriptor<CodeCoverageProvider>

Specified by:

getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<CodeCoverageProvider>

enabled

public void enabled()

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

enabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<CodeCoverageProvider>

disabled

public void disabled()

Specified by:

disabled in interface com.atlassian.plugin.StateAware

Overrides:

disabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<CodeCoverageProvider>

validate

protected void validate(com.atlassian.plugin.module.Element element)

Overrides:

validate in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<CodeCoverageProvider>