View Javadoc

1   package com.atlassian.plugin.webresource;
2   
3   import java.util.List;
4   
5   /**
6    * Resource batching configuration for the {@link WebResourceManagerImpl}.
7    *
8    * Currently contains the configuration for super batch support.
9    */
10  public interface ResourceBatchingConfiguration
11  {
12      /**
13       * Gets whether web resources in different resource modules should be batched together.
14       */
15      boolean isSuperBatchingEnabled();
16  
17      /**
18       * Gets the list of resource plugin modules that should be included in the superbatch, in the order that
19       * they should be batched. No dependency resolution is performed, so it is important that the configuration
20       * includes all dependent resources in the right order.
21       *
22       * Any call to {@link WebResourceManager#requireResource} for one of these resources will be a no-op,
23       * and any dependency resolution for resources will stop if the dependency is in the superbatch.
24       */
25      List<String> getSuperBatchModuleCompleteKeys();
26  }