com.atlassian.plugin.webresource.prebake

Class DimensionUnawareOverride

java.lang.Object

com.atlassian.plugin.webresource.prebake.DimensionUnawareOverride

Deprecated.

@Deprecated
public final class DimensionUnawareOverride
extends Object

Override Dimensions values for dimension-unaware conditions.

This class is used to inject dimensionality in dimension-unaware conditions while we wait for the teams owning those conditions to update them. It's a stopgap measure, hence its deprecated state, and should only be used when we need a quick way to untaint some resources for prebaking.

It's important to note that injecting dimensions using this class only works when the overridden condition does not contribute to the resource hash. In that case, the only way to add dimensionality is by updating the condition to be dimension-aware.

The methods in this class are only used while prebaking.

Since:

v3.5.27

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DimensionUnawareOverride.DimensionOverride Deprecated.

Constructor Summary

Constructors

Constructor and Description
DimensionUnawareOverride() Deprecated.

Method Summary

Modifier and Type	Method and Description
static boolean	contains(String className) Deprecated. Indicates whether there are dimension overrides for a particular condition class.
static Dimensions	dimensions(String className) Deprecated. Returns the dimension values to be used at prebake time when prebaking resources that use the condition identified by the class name passed as parameter.
static String	key(String className) Deprecated. Returns the query string key to be used at prebake time when the condition identified by the class name passed as parameter will contribute to the URL.
static void	reset() Deprecated. Removes all condition overrides
static void	setup(Collection<DimensionUnawareOverride.DimensionOverride> overrides) Deprecated. Registers Dimensions overrides to apply to dimension-unaware conditions.
static int	size() Deprecated. Number of registered overrides.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DimensionUnawareOverride

public DimensionUnawareOverride()

Deprecated.

Method Detail

setup

public static void setup(Collection<DimensionUnawareOverride.DimensionOverride> overrides)

Deprecated.

Registers Dimensions overrides to apply to dimension-unaware conditions. Invoking this method will remove all existing overrides, and substitute them with the content of the collection passed as parameter.

A DimensionUnawareOverride.DimensionOverride indicates the condition class to which it has to be applied, the query string key, and all the possible dimension values that the condition can assume at runtime.

DimensionUnawareOverride.DimensionOverrides are only applied if the condition is not dimension-aware.

Parameters:

overrides - dimension overrides

reset

public static void reset()

Deprecated.

Removes all condition overrides

contains

public static boolean contains(String className)

Deprecated.

Indicates whether there are dimension overrides for a particular condition class.

Parameters:

className - name of the class

Returns:

true if there are condition overrides for the class, false otherwise

key

public static String key(String className)

Deprecated.

Returns the query string key to be used at prebake time when the condition identified by the class name passed as parameter will contribute to the URL.

Parameters:

className - name of the class

Returns:

query string key to be employed when prebaking resources that use the condition class passed as parameter

dimensions

public static Dimensions dimensions(String className)

Deprecated.

Returns the dimension values to be used at prebake time when prebaking resources that use the condition identified by the class name passed as parameter.

Parameters:

className - name of the class

Returns:

dimensions to be employed when prebaking resources that use the condition class passed as parameter

size

public static int size()

Deprecated.

Number of registered overrides.

Returns:

number of registered overrides.