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

Class SuperBatchWebResources

java.lang.Object

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

public class SuperBatchWebResources
extends Object

Represents the set of superbatch web resources required for rendering a FormattedBody. You may need to combine these resources with the other resources in WebResourceDependencies to completely render a piece of content. The uri field is a map of the ResourceType to a list of URI of that resource. The tags is a map of the ResourceType to a html string of the tags of those resources as it would have been rendered in the browser when viewing the content. Standard expansions mechanisms apply to this object when requested through REST. For example, to get all of the css tags, use tags.css as the expansion (prepending any expansions required to reach this object, such as webresource.superbatch for the FormattedBody object).

Since:

5.10

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SuperBatchWebResources.Expansions	Holds the string representable of the expandable fields of SuperBatchWebResources.
static class	SuperBatchWebResources.SuperBatchWebResourcesBuilder	Builder for SuperBatchWebResources

Method Summary

Modifier and Type	Method	Description
static SuperBatchWebResources.SuperBatchWebResourcesBuilder	builder()
HtmlString	getMetatags()
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

Method Details

builder

public static SuperBatchWebResources.SuperBatchWebResourcesBuilder builder()

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.

getMetatags

public HtmlString getMetatags()

Returns:

a html string containing the meta tags required for the enclosing formatted body