com.atlassian.plugin.webresource
Interface PluginResource

All Known Implementing Classes:

BatchPluginResource, SinglePluginResource, SuperBatchPluginResource

public interface PluginResource

Represents a plugin resource. This object represents a page-time resource. It is used build a URL to the underlying resource, but does not know how to get the contents of that resource itself.

Since:

2.2

Method Summary

Set<com.atlassian.plugin.webresource.BatchedWebResourceDescriptor>	getBatchedWebResourceDescriptors() This method provides the mechanism for discovering the contents of a PluginResource.
String	getModuleCompleteKey()
Map<String,String>	getParams()
String	getResourceName()
String	getType()
String	getUrl()
String	getVersion(WebResourceIntegration integration)
boolean	isCacheSupported()

Method Detail

isCacheSupported

boolean isCacheSupported()

Returns:

true if caching for this resource is supported. Use this check to append a static caching url prefix to this resource's url.

getUrl

String getUrl()

Returns:

the url for this plugin resource.

getResourceName

String getResourceName()

Returns:

the resource name for the plugin resource.

getModuleCompleteKey

String getModuleCompleteKey()

Returns:

the plugin module's complete key for which this resource belongs to.

getParams

Map<String,String> getParams()

Returns:

a map of parameter key and value pairs for this resource.

getVersion

String getVersion(WebResourceIntegration integration)

Returns:

the version prefix string for a cached resource

getType

String getType()

Returns:

the type (e.g. file extension) of the resource.

Since:

2.12.3

getBatchedWebResourceDescriptors

Set<com.atlassian.plugin.webresource.BatchedWebResourceDescriptor> getBatchedWebResourceDescriptors()

This method provides the mechanism for discovering the contents of a PluginResource.

The primary use of this method is in providing a representation of the contents (for dependency tracking) when formatting a PluginResource.

Returns:

a Set of descriptors providing information about the contents of this PluginResource.