com.atlassian.webresource.api.assembler

Interface RequiredResources

@ExperimentalApi
public interface RequiredResources

Interface for clients to require web resources.

Note, RequiredResources is currently an experimental API and may break between versions of web resources. It is advised that you use WebResourceManager in the mean time if you require a stable API.

Since:

v3.0

See Also:

WebResourceAssembler, PageBuilderService

Method Summary

Modifier and Type	Method and Description
RequiredResources	exclude(Set<String> webResources, Set<String> contexts) Specifies that the given resources should be excluded from all future calls to drainIncludedResources().
RequiredResources	requireContext(String context) Specifies that resources for the given webresource context should be included on the next call to drainIncludedResources().
RequiredResources	requireModule(String name) Specifies that the given module should be included on the next call to drainIncludedResources().
RequiredResources	requirePage(String key) Includes all contexts and resources specified in the root-page into the WebResourceAssembler.
RequiredResources	requireWebResource(String moduleCompleteKey) Specifies that resources for the given module should be included on the next call to drainIncludedResources().

Method Detail

requireWebResource

RequiredResources requireWebResource(String moduleCompleteKey)

Specifies that resources for the given module should be included on the next call to drainIncludedResources().

Parameters:

moduleCompleteKey - key of webresource module

Returns:

this, to support method chaining

requireModule

RequiredResources requireModule(String name)

Specifies that the given module should be included on the next call to drainIncludedResources().

Parameters:

name - name of module

Returns:

this, to support method chaining

Since:

3.4.8

requireContext

RequiredResources requireContext(String context)

Specifies that resources for the given webresource context should be included on the next call to drainIncludedResources().

Parameters:

context - webresource context to include

Returns:

this, to support method chaining

exclude

RequiredResources exclude(Set<String> webResources,
                          Set<String> contexts)

Specifies that the given resources should be excluded from all future calls to drainIncludedResources(). This is equivalent to requiring the given webresources and contexts then calling drain().

Any currently un-drained resources/contexts will be remain and be included in the next drain.

If this WebResourceAssembler includes implicit resources (e.g. "superbatch"), this call will also exclude all such implicit resources from future calls to drainIncludedResources().

Parameters:

webResources - webresource keys to exclude.

contexts - contexts to exclude.

Returns:

this, to support method chaining

requirePage

RequiredResources requirePage(String key)

Includes all contexts and resources specified in the root-page into the WebResourceAssembler.

Parameters:

key - key of the root page

Returns:

this, to support method chaining

Since:

3.5.22