com.atlassian.plugin.webresource
Interface ResourceBatchingConfiguration

All Known Implementing Classes:
DefaultResourceBatchingConfiguration

public interface ResourceBatchingConfiguration

Resource batching configuration for the WebResourceManagerImpl. Currently contains the configuration for batch support.


Method Summary
 List<String> getSuperBatchModuleCompleteKeys()
          Gets the list of resource plugin modules that should be included in the superbatch, in the order that they should be batched.
 boolean isContextBatchingEnabled()
          Determines whether web resources in the same context should be batched together.
 boolean isPluginWebResourceBatchingEnabled()
          Determines whether plugin resources of the same type defined within a single web resource are batched into one file.
 boolean isSuperBatchingEnabled()
          Gets whether web resources in different resource modules should be batched together.
 

Method Detail

isSuperBatchingEnabled

boolean isSuperBatchingEnabled()
Gets whether web resources in different resource modules should be batched together.

Returns:
true if web resources in different resource modules should be batched together

getSuperBatchModuleCompleteKeys

List<String> getSuperBatchModuleCompleteKeys()
Gets the list of resource plugin modules that should be included in the superbatch, in the order that they should be batched. No dependency resolution is performed, so it is important that the configuration includes all dependent resources in the right order. Any call to WebResourceManager.requireResource(java.lang.String) for one of these resources will be a no-op, and any dependency resolution for resources will stop if the dependency is in the superbatch.

Returns:
a list of resource plugin modules that should be included in the superbatch.

isContextBatchingEnabled

boolean isContextBatchingEnabled()
Determines whether web resources in the same context should be batched together.

Returns:
true if web resources in the same context are batched together.
Since:
2.9.0

isPluginWebResourceBatchingEnabled

boolean isPluginWebResourceBatchingEnabled()
Determines whether plugin resources of the same type defined within a single web resource are batched into one file.

Returns:
true if plugin resources in the same web resource are batched together.
Since:
2.9.0


Copyright © 2011 Atlassian. All Rights Reserved.