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 Description static interface
WebResourceDependenciesRecorder.RecordedResources
Holds the various resources that are recorded fromrecordResources(Callable)
.
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description default <T> com.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources>
record(Iterable<String> additionalContexts, Iterable<String> additionalResources, boolean includeSuperbatch, Callable<T> callback)
Deprecated.since 7.0 userecordResources(Callable, Consumer, Consumer)
default <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)
Deprecated.since 7.0 userecordResources(Callable, Consumer, Consumer)
default <T> com.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources>
record(Iterable<String> additionalContexts, Iterable<String> additionalResources, Callable<T> callback)
Deprecated.since 7.0 userecordResources(Callable, Consumer, Consumer)
default <T> com.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources>
record(Callable<T> callback)
Deprecated.since 7.0.1.default <T> io.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources>
recordResources(Iterable<String> additionalContexts, Iterable<String> additionalResources, boolean includeSuperbatch, Callable<T> callback)
Deprecated.since 8.8 userecordResources(Callable, Consumer, Consumer)
default <T> io.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources>
recordResources(Iterable<String> additionalContexts, Iterable<String> additionalResources, Iterable<String> excludeContexts, Iterable<String> excludeResources, boolean includeSuperbatch, Callable<T> callback)
Deprecated.since 8.8 userecordResources(Callable, Consumer, Consumer)
default <T> io.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources>
recordResources(Iterable<String> additionalContexts, Iterable<String> additionalResources, Callable<T> callback)
Deprecated.since 8.8 userecordResources(Callable, Consumer, Consumer)
default <T> io.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources>
recordResources(Callable<T> callback)
Deprecated.since 8.8 userecordResources(Callable, Consumer, Consumer)
<T> io.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources>
recordResources(Callable<T> renderAction, Consumer<com.atlassian.webresource.api.assembler.RequiredResources> requiredResourcesCallback, Consumer<com.atlassian.webresource.api.assembler.WebResourceAssemblerBuilder> assemblerBuilderCallback)
-
-
-
Method Detail
-
recordResources
<T> io.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources> recordResources(Callable<T> renderAction, Consumer<com.atlassian.webresource.api.assembler.RequiredResources> requiredResourcesCallback, Consumer<com.atlassian.webresource.api.assembler.WebResourceAssemblerBuilder> assemblerBuilderCallback) throws Exception
- Throws:
Exception
- Since:
- 8.8
-
record
@Deprecated default <T> com.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources> record(Callable<T> callback) throws Exception
Deprecated.since 7.0.1. UserecordResources(Callable)
Records the webresources used during the execution of the given callback. Same as callingrecordResources(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.
-
recordResources
@Deprecated default <T> io.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources> recordResources(Callable<T> callback) throws Exception
Deprecated.since 8.8 userecordResources(Callable, Consumer, Consumer)
Records the webresources used during the execution of the given callback. Same as callingrecordResources(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.- Since:
- 7.0.1
-
record
@Deprecated default <T> com.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources> record(Iterable<String> additionalContexts, Iterable<String> additionalResources, Callable<T> callback) throws Exception
Deprecated.since 7.0 userecordResources(Callable, Consumer, Consumer)
Same as callingrecordResources(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.
-
recordResources
@Deprecated default <T> io.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources> recordResources(Iterable<String> additionalContexts, Iterable<String> additionalResources, Callable<T> callback) throws Exception
Deprecated.since 8.8 userecordResources(Callable, Consumer, Consumer)
Same as callingrecordResources(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
@Deprecated default <T> com.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources> record(Iterable<String> additionalContexts, Iterable<String> additionalResources, boolean includeSuperbatch, Callable<T> callback) throws Exception
Deprecated.since 7.0 userecordResources(Callable, Consumer, Consumer)
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.
-
recordResources
@Deprecated default <T> io.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources> recordResources(Iterable<String> additionalContexts, Iterable<String> additionalResources, boolean includeSuperbatch, Callable<T> callback) throws Exception
Deprecated.since 8.8 userecordResources(Callable, Consumer, Consumer)
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.- Since:
- 7.0.1
-
record
@Deprecated default <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
Deprecated.since 7.0 userecordResources(Callable, Consumer, Consumer)
- Throws:
Exception
-
recordResources
@Deprecated default <T> io.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources> recordResources(Iterable<String> additionalContexts, Iterable<String> additionalResources, Iterable<String> excludeContexts, Iterable<String> excludeResources, boolean includeSuperbatch, Callable<T> callback) throws Exception
Deprecated.since 8.8 userecordResources(Callable, Consumer, Consumer)
- Throws:
Exception
- Since:
- 7.0.1
-
-