com.atlassian.confluence.api.model.content.webresource

Class WebResourceDependencies

java.lang.Object

com.atlassian.confluence.api.model.content.webresource.WebResourceDependencies

@ExperimentalApi
public class WebResourceDependencies
extends Object

A model for web resources that a FormattedBody's various ContentRepresentation might require to render properly on the client.

Since:

5.9

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebResourceDependencies.Expansions Holds the string representable of the expandable fields of WebResourceDependencies.
static class	WebResourceDependencies.WebResourceDependenciesBuilder Builder for WebResourceDependencies

Constructor Summary

Constructors

Constructor and Description
WebResourceDependencies(List<String> keys, List<String> contexts, Map<ResourceType,List<URI>> uris, Map<ResourceType,HtmlString> tags, SuperBatchWebResources superbatch)

Method Summary

Modifier and Type	Method and Description
static WebResourceDependencies.WebResourceDependenciesBuilder	builder()
List<String>	getContexts()
List<String>	getKeys()
SuperBatchWebResources	getSuperbatch()
Map<ResourceType,HtmlString>	getTags()
Map<ResourceType,List<URI>>	getUris()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebResourceDependencies

public WebResourceDependencies(List<String> keys,
                               List<String> contexts,
                               Map<ResourceType,List<URI>> uris,
                               Map<ResourceType,HtmlString> tags,
                               SuperBatchWebResources superbatch)

Method Detail

builder

public static WebResourceDependencies.WebResourceDependenciesBuilder builder()

getContexts

public List<String> getContexts()

Returns:

A list of web resource contexts. These contexts are explicitly requested, or implicitly included for the content under question. It does _not_ include transitives. Suitable for use by WRM.requireContext() via client side javascript.

getKeys

public List<String> getKeys()

Returns:

A list of web resource keys. These keys are explicitly requested by the rendering of the content under question. It does _not_ include dependencies that are not explicitly requested. Suitable for use by WRM.requireResoure() via client side javascript.

getUris

public Map<ResourceType,List<URI>> getUris()

Returns:

A map of UIRs keyed by the type of URI. Does not include ResourceType.DATA, as that type does not have a uri associated with it.

getTags

public Map<ResourceType,HtmlString> getTags()

Returns:

A map of the raw tags keyed by the type of the resource.

getSuperbatch

public SuperBatchWebResources getSuperbatch()

Returns:

a representation of the superbatch.