com.atlassian.confluence.plugin.descriptor.api

Class ModelMetadataProviderModuleDescriptor

java.lang.Object

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

com.atlassian.confluence.plugin.descriptor.DefaultFactoryModuleDescriptor<ModelMetadataProvider>

com.atlassian.confluence.plugin.descriptor.api.ModelMetadataProviderModuleDescriptor

All Implemented Interfaces:

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

public class ModelMetadataProviderModuleDescriptor
extends DefaultFactoryModuleDescriptor<ModelMetadataProvider>

Describes a plugin module for adding metadata to API Model objects

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
ModelMetadataProviderModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Summary

Modifier and Type	Method and Description
ModelMetadataProvider	getModule() Implementing classes should implement this method and call getModuleFromProvider, this is required as AbstractModuleDescriptor.getModuleReturnClass() uses the return type of this method to determine the module class.

Methods inherited from class com.atlassian.confluence.plugin.descriptor.DefaultFactoryModuleDescriptor

disabled, enabled, getModuleFromProvider, init

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, isBroken, isEnabled, isEnabledByDefault, isSystemModule, loadClass, provideValidationRules, 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

Constructor Detail

ModelMetadataProviderModuleDescriptor

public ModelMetadataProviderModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Detail

getModule

public ModelMetadataProvider getModule()

Description copied from class: DefaultFactoryModuleDescriptor

Implementing classes should implement this method and call getModuleFromProvider, this is required as AbstractModuleDescriptor.getModuleReturnClass() uses the return type of this method to determine the module class. The JVM's type erasure means that it must be implemented with a non-generic type for getModuleReturnClass() to succeed.

Specified by:

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

Specified by:

getModule in class DefaultFactoryModuleDescriptor<ModelMetadataProvider>