com.atlassian.confluence.plugin.webresource

Interface WebResourceDependenciesRecorder

All Known Implementing Classes:

ThreadlocalWebResourceDependenciesRecorder

public interface WebResourceDependenciesRecorder

Records the usages of various web resources when they are rendered.

Since:

5.9

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	WebResourceDependenciesRecorder.RecordedResources Holds the various resources that are recorded from record(Callable).

Method Summary

Modifier and Type	Method and Description
<T> com.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources>	record(Callable<T> callback) Records the webresources used during the execution of the given callback.
<T> com.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources>	record(Iterable<String> additionalContexts, Iterable<String> additionalResources, boolean includeSuperbatch, Callable<T> callback) Records the webresources used during the execution of the given callback.
<T> com.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources>	record(Iterable<String> additionalContexts, Iterable<String> additionalResources, Callable<T> callback) Same as calling record(Iterable, Iterable, boolean, Callable), but with superbatch set to false.
<T> com.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources>	record(Iterable<String> additionalContexts, Iterable<String> additionalResources, Iterable<String> excludeContexts, Iterable<String> excludeResources, boolean includeSuperbatch, Callable<T> callback)

Method Detail

record

<T> com.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources> record(Callable<T> callback)
                                                                                  throws Exception

Records the webresources used during the execution of the given callback. Same as calling record(Iterable, Iterable, Callable) without any overrides.

Type Parameters:

T - the return value of the callback

Parameters:

callback - the code to execute during recording

Returns:

a pair of objects. Left is the value returned by the callback, right is the set of webresources that is assembled during the execution of the given callback.

Throws:

Exception - if the callback threw an exception.

record

<T> com.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources> record(Iterable<String> additionalContexts,
                                                                                         Iterable<String> additionalResources,
                                                                                         Callable<T> callback)
                                                                                  throws Exception

Same as calling record(Iterable, Iterable, boolean, Callable), but with superbatch set to false.

Type Parameters:

T - the return value of the callback.

Parameters:

additionalContexts - the context that should be added to the set of webresources (which may not be in the callback)

additionalResources - the additional resources that should be added to the set of webresources (which may not be in the callback)

callback - the code to execute during recording

Returns:

a pair of objects. Left is the value returned by the callback, right is the set of webresources that is assembled during the execution of the given callback.

Throws:

Exception - if the callback threw an exception.

record

<T> com.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources> record(Iterable<String> additionalContexts,
                                                                                         Iterable<String> additionalResources,
                                                                                         boolean includeSuperbatch,
                                                                                         Callable<T> callback)
                                                                                  throws Exception

Records the webresources used during the execution of the given callback.

Type Parameters:

T - the return value of the callback.

Parameters:

additionalContexts - the context that should be added to the set of webresources (which may not be in the callback)

additionalResources - the additional resources that should be added to the set of webresources (which may not be in the callback)

includeSuperbatch - true if the record should include the superbatch.

callback - the code to execute during recording

Returns:

a pair of objects. Left is the value returned by the callback, right is the set of webresources that is assembled during the execution of the given callback.

Throws:

Exception - if the callback threw an exception.

record

<T> com.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources> record(Iterable<String> additionalContexts,
                                                                                         Iterable<String> additionalResources,
                                                                                         Iterable<String> excludeContexts,
                                                                                         Iterable<String> excludeResources,
                                                                                         boolean includeSuperbatch,
                                                                                         Callable<T> callback)
                                                                                  throws Exception

Throws:

Exception