com.atlassian.webresource.api.assembler

Interface WebResourceSet

@ExperimentalApi
public interface WebResourceSet

Set of assembled web resources and web resources contexts.

Since:

v3.0

Method Summary

Modifier and Type	Method and Description
Iterable<WebResource>	getResources() Returns a list of included WebResources
<T extends WebResource> Iterable<T>	getResources(Class<T> clazz) Returns a filtered list of included WebResources matching the given class
boolean	isComplete() If promises of data have been required via RequiredData.requireData(String, CompletionStage) then this WebResourceSet will only contain the completed promises.
void	writeHtmlTags(Writer writer, UrlMode urlMode) Write the HTML tags for this object's resources to the writer.
void	writeHtmlTags(Writer writer, UrlMode urlMode, com.google.common.base.Predicate<WebResource> predicate) Write the HTML tags for this object's resources to the writer.
void	writePrefetchLinks(Writer writer, UrlMode urlMode) Write the HTML tags for non-data resources as prefetch links: <link rel="prefetch">.

Method Detail

writeHtmlTags

void writeHtmlTags(Writer writer,
                   UrlMode urlMode)

Write the HTML tags for this object's resources to the writer. Writing will be done in order of webResourceFormatters so that all CSS resources will be output before Javascript.

Parameters:

writer - writer to output to

urlMode - url formatting mode

writeHtmlTags

void writeHtmlTags(Writer writer,
                   UrlMode urlMode,
                   com.google.common.base.Predicate<WebResource> predicate)

Write the HTML tags for this object's resources to the writer. Writing will be done in order of webResourceFormatters so that all CSS resources will be output before Javascript.

Parameters:

writer - writer to output to

urlMode - url formatting mode

predicate - only resources matching this predicate will be written

writePrefetchLinks

void writePrefetchLinks(Writer writer,
                        UrlMode urlMode)

Write the HTML tags for non-data resources as prefetch links: <link rel="prefetch">. Data resources will not be output. Writing will be done in the same order as the resources appear in this set, not ordered by type. Typical usage: WebResourceAssembler pageAssembler = wr.getPageBuilderService().assembler(); WebResourceAssembler prefetchAssembler = pageAssembler.copy(); pageAssembler.resources().requireWebResource("myplugin:resource-for-this-page"); WebResourceSet pageSet = pageAssembler.assembled().drainIncludedResources(); pageSet.writeHtmlTags(writer, urlMode); prefetchAssembler.resources().requireWebResource("myplugin:resource-for-next-page"); WebResourceSet prefetchSet = prefetchAssembler.assembled().drainIncludedResources(); prefetchSet.writePrefetchLinks(writer, urlMode);

Parameters:

writer - writer to output to

urlMode - url formatting mode

Since:

3.6.0

getResources

Iterable<WebResource> getResources()

Returns a list of included WebResources

Returns:

included resources

getResources

<T extends WebResource> Iterable<T> getResources(Class<T> clazz)

Returns a filtered list of included WebResources matching the given class

Parameters:

clazz - class of webresource to return

Returns:

included resources

isComplete

boolean isComplete()

If promises of data have been required via RequiredData.requireData(String, CompletionStage) then this WebResourceSet will only contain the completed promises. This method indicates if there are no promises left.

Returns:

true if there is nothing more to drain.