com.atlassian.webresource.api.assembler.resource

Interface PluginUrlResource<T extends PluginUrlResourceParams>

All Superinterfaces:

WebResource

All Known Subinterfaces:

PluginCssResource, PluginJsResource

@ExperimentalApi
public interface PluginUrlResource<T extends PluginUrlResourceParams>
extends WebResource

Representation of a resource accessible via a URL

Since:

v3.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PluginUrlResource.BatchType

Method Summary

Modifier and Type	Method and Description
PluginUrlResource.BatchType	getBatchType()
String	getKey()
T	getParams() Returns params that go outside this url's querystring.
List<PrebakeError>	getPrebakeErrors() If this url was generated as part of a pre-bake, this indicates any errors that occured.
String	getStaticUrl(UrlMode urlMode) The resource's url.
boolean	isTainted()

Method Detail

getStaticUrl

String getStaticUrl(UrlMode urlMode)

The resource's url.

Parameters:

urlMode - url mode, either absolute or relative

Returns:

the url to this resource, prefixed by a static resource. If caching has been disabled for this resource, the raw url without the static prefix is returned.

getParams

T getParams()

Returns params that go outside this url's querystring. Examples are conditional comments, ie only, media queries and attributes that may be added to an HTML tag

Returns:

non-querystring params

isTainted

boolean isTainted()

getPrebakeErrors

List<PrebakeError> getPrebakeErrors()

If this url was generated as part of a pre-bake, this indicates any errors that occured.

getKey

String getKey()

Returns:

the WRM key(s) contained in this resource (e.g. "_super")

Since:

3.5.12

getBatchType

PluginUrlResource.BatchType getBatchType()

Returns:

the type of resources contained in this batch (either "context" or "resource")

Since:

3.5.12