Package com.atlassian.webresource.api.descriptor

Interface WebResourceModuleDescriptor

All Superinterfaces:
com.atlassian.plugin.ModuleDescriptor<Void>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware
public interface WebResourceModuleDescriptor extends com.atlassian.plugin.ModuleDescriptor<Void>
Missing the following; getting the composite condition, getting the transformations, getting the data providers, and getting the deprecation details. If any of those sound like something you need, let us know, you can comment on Developer Community or on this ticket.
Since:
7.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<String>
    getContextDependencies()
    Returns the set of contexts that this web-resource depends on, this is only relevant is this web-resource is defining a root page (isRootPage())
    Set<String>
    getContexts()
     
    List<String>
    getDependencies()
    Returns a list of dependencies on other web-resources.
    boolean
    isDeprecated()
     
    boolean
    isDisableMinification()
     
    boolean
    isRootPage()
    Declares if this web-resource is defining the root page, e.g.

    Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

    destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getDisplayName, getI18nNameKey, getKey, getMinJavaVersion, getModule, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, init, isBroken, isEnabled, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setBroken

    Methods inherited from interface com.atlassian.plugin.Resourced

    getResourceDescriptor, getResourceDescriptors, getResourceLocation

    Methods inherited from interface com.atlassian.plugin.ScopeAware

    getScopeKey

  • Method Details

    • getContexts

      Set<String> getContexts()
      Returns:
      the web-resource contexts this resource is associated with.

    • getContextDependencies

      Set<String> getContextDependencies()
      Returns the set of contexts that this web-resource depends on, this is only relevant is this web-resource is defining a root page (isRootPage())
      Returns:
      the set of contexts that this resource depends on

    • getDependencies

      List<String> getDependencies()
      Returns a list of dependencies on other web-resources.
      Returns:
      a list of module complete keys

    • isRootPage

      boolean isRootPage()
      Declares if this web-resource is defining the root page, e.g. 'issue view page', 'dashboard page'
      Returns:
      an Option of the RootPage object

    • isDeprecated

      boolean isDeprecated()
      Returns:
      true if the web-resource is deprecated, false otherwise.

    • isDisableMinification

      boolean isDisableMinification()
      Returns:
      true if resource minification should be skipped, false otherwise.