public abstract class

AbstractScmRequestHandlerModuleDescriptor

extends BaseWeightedModuleDescriptor<T>
java.lang.Object
   ↳ com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
     ↳ com.atlassian.stash.scm.BaseWeightedModuleDescriptor<T>
       ↳ com.atlassian.stash.scm.AbstractScmRequestHandlerModuleDescriptor<T>
Known Direct Subclasses

Class Overview

A base class for constructing module descriptors for ScmRequest handlers.

Summary

[Expand]
Inherited Fields
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
From interface com.atlassian.stash.util.Weighted
Public Constructors
AbstractScmRequestHandlerModuleDescriptor(ModuleFactory moduleFactory, int defaultWeight)
Public Methods
@Nonnull T getModule()
@Nullable String getScm()
Retrieves the ID of the SCM this handler adds support for, or null if this handler does not, of itself, add support for any specific SCM.
@Nullable ScmUrlFormatter getUrlFormatter()
Retrieves the ScmUrlFormatter which should be used to format clone URLs targeting this handler.
void init(Plugin plugin, Element element)
Protected Methods
void provideValidationRules(ValidationPattern pattern)
[Expand]
Inherited Methods
From class com.atlassian.stash.scm.BaseWeightedModuleDescriptor
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
From class java.lang.Object
From interface com.atlassian.plugin.ModuleDescriptor
From interface com.atlassian.plugin.Resourced
From interface com.atlassian.plugin.StateAware
From interface com.atlassian.stash.util.Weighted
From interface java.lang.Comparable

Public Constructors

public AbstractScmRequestHandlerModuleDescriptor (ModuleFactory moduleFactory, int defaultWeight)

Public Methods

@Nonnull public T getModule ()

@Nullable public String getScm ()

Retrieves the ID of the SCM this handler adds support for, or null if this handler does not, of itself, add support for any specific SCM.

Returns
  • the SCM this handler adds support for, or null

@Nullable public ScmUrlFormatter getUrlFormatter ()

Retrieves the ScmUrlFormatter which should be used to format clone URLs targeting this handler. If no formatter is specified, a default URL will be generated.

Returns
  • a URL formatter, or null to use the default URL

public void init (Plugin plugin, Element element)

Throws
PluginParseException

Protected Methods

protected void provideValidationRules (ValidationPattern pattern)