com.android.ide.common.resources

Class ResourceResolver

java.lang.Object

com.android.ide.common.rendering.api.RenderResources

com.android.ide.common.resources.ResourceResolver

public class ResourceResolver
extends com.android.ide.common.rendering.api.RenderResources

NOTE: LayoutLib tests depend on this class.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.regex.Pattern	DEVICE_DEFAULT_PATTERN
static java.lang.String	LEGACY_THEME Constant passed to setDeviceDefaults(String) to indicate the DeviceDefault styles should point to the default styles
static int	MAX_RESOURCE_INDIRECTION Number of indirections we'll follow for resource resolution before assuming there is a cyclic dependency error in the input.
static java.lang.String	THEME_NAME
static java.lang.String	THEME_NAME_DOT

Fields inherited from class com.android.ide.common.rendering.api.RenderResources

REFERENCE_EMPTY, REFERENCE_NULL, REFERENCE_UNDEFINED

Method Summary

Modifier and Type	Method and Description
void	applyStyle(com.android.ide.common.rendering.api.StyleResourceValue theme, boolean useAsPrimary)
void	clearStyles()
static ResourceResolver	copy(ResourceResolver original) Creates a new ResourceResolver copied from the given instance.
static ResourceResolver	create(java.util.Map<com.android.ide.common.rendering.api.ResourceNamespace,java.util.Map<com.android.resources.ResourceType,ResourceValueMap>> resources, com.android.ide.common.rendering.api.ResourceReference themeReference) Creates a new ResourceResolver object.
ResourceResolver	createRecorder(java.util.List<com.android.ide.common.rendering.api.ResourceValue> lookupChain) Creates a new ResourceResolver which records all resource resolution lookups into the given list.
com.android.ide.common.rendering.api.ResourceValue	dereference(com.android.ide.common.rendering.api.ResourceValue value)
com.android.ide.common.rendering.api.StyleItemResourceValue	findItemInStyle(com.android.ide.common.rendering.api.StyleResourceValue style, com.android.ide.common.rendering.api.ResourceReference attr)
com.android.ide.common.rendering.api.ResourceValue	findItemInStyle(com.android.ide.common.rendering.api.StyleResourceValue style, java.lang.String attrName, boolean isFrameworkAttr) Deprecated. Use findItemInStyle(StyleResourceValue, ResourceReference).
com.android.ide.common.rendering.api.ResourceValue	findItemInTheme(java.lang.String attrName, boolean isFrameworkAttr) Deprecated. Use RenderResources.findItemInTheme(ResourceReference).
java.util.List<com.android.ide.common.rendering.api.StyleResourceValue>	getAllThemes()
java.util.Collection<com.android.ide.common.rendering.api.StyleResourceValue>	getChildren(com.android.ide.common.rendering.api.StyleResourceValue style)
com.android.ide.common.rendering.api.StyleResourceValue	getCurrentTheme() Deprecated. Use getDefaultTheme() or getAllThemes()
com.android.ide.common.rendering.api.StyleResourceValue	getDefaultTheme()
com.android.ide.common.rendering.api.ResourceValue	getFrameworkResource(com.android.resources.ResourceType resourceType, java.lang.String resourceName) Deprecated. Use RenderResources.getResolvedResource(ResourceReference)
java.util.Map<com.android.resources.ResourceType,ResourceValueMap>	getFrameworkResources() Deprecated.
com.android.ide.common.rendering.api.StyleResourceValue	getParent(com.android.ide.common.rendering.api.StyleResourceValue style)
com.android.ide.common.rendering.api.ResourceValue	getProjectResource(com.android.resources.ResourceType resourceType, java.lang.String resourceName) Deprecated. Use RenderResources.getResolvedResource(ResourceReference)
java.util.Map<com.android.resources.ResourceType,ResourceValueMap>	getProjectResources() Deprecated.
com.android.ide.common.rendering.api.StyleResourceValue	getStyle(com.android.ide.common.rendering.api.ResourceReference styleReference)
com.android.ide.common.rendering.api.StyleResourceValue	getStyle(java.lang.String styleName, boolean isFramework) Deprecated. Use getStyle(ResourceReference)
com.android.ide.common.rendering.api.StyleResourceValue	getTheme()
com.android.ide.common.rendering.api.StyleResourceValue	getTheme(java.lang.String name, boolean frameworkTheme) Deprecated. Use getStyle(ResourceReference)
com.android.ide.common.rendering.api.ResourceValue	getUnresolvedResource(com.android.ide.common.rendering.api.ResourceReference reference)
boolean	isTheme(com.android.ide.common.rendering.api.ResourceValue value, java.util.Map<com.android.ide.common.rendering.api.ResourceValue,java.lang.Boolean> cache) Checks if the given ResourceValue represents a theme.
com.android.ide.common.rendering.api.ResourceValue	resolveResValue(com.android.ide.common.rendering.api.ResourceValue resValue) If the given resource value contains a reference, resolves that reference to the actual value.
void	setDeviceDefaults(java.lang.String deviceDefaultParent) This will override the DeviceDefault styles so they point to the given parent styles (e.g.
void	setLogger(com.android.ide.common.rendering.api.LayoutLog logger)
boolean	styleExtends(com.android.ide.common.rendering.api.StyleResourceValue child, com.android.ide.common.rendering.api.StyleResourceValue ancestor)
boolean	themeIsChildOfAny(com.android.ide.common.rendering.api.StyleResourceValue childTheme, com.android.ide.common.rendering.api.StyleResourceValue... parentThemes) Returns whether a theme is a child of at least one of the specified parents.
static ResourceResolver	withValues(java.lang.Iterable<com.android.ide.common.rendering.api.ResourceValue> values, com.android.ide.common.rendering.api.ResourceReference themeReference) Creates a new ResourceResolver which contains only the given ResourceValue objects, indexed by namespace, type and name.
static ResourceResolver	withValues(com.android.ide.common.rendering.api.ResourceValue... values) Creates a new ResourceResolver which contains only the given ResourceValue objects, indexed by namespace, type and name.

Methods inherited from class com.android.ide.common.rendering.api.RenderResources

findItemInTheme, findResValue, getResolvedResource

Methods inherited from class java.lang.Object

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

Field Detail

MAX_RESOURCE_INDIRECTION

public static final int MAX_RESOURCE_INDIRECTION

Number of indirections we'll follow for resource resolution before assuming there is a cyclic dependency error in the input.

See Also:

Constant Field Values

THEME_NAME

public static final java.lang.String THEME_NAME

See Also:

Constant Field Values

THEME_NAME_DOT

public static final java.lang.String THEME_NAME_DOT

See Also:

Constant Field Values

LEGACY_THEME

public static final java.lang.String LEGACY_THEME

Constant passed to setDeviceDefaults(String) to indicate the DeviceDefault styles should point to the default styles

See Also:

Constant Field Values

DEVICE_DEFAULT_PATTERN

public static final java.util.regex.Pattern DEVICE_DEFAULT_PATTERN

Method Detail

create

@NonNull
public static ResourceResolver create(@NonNull
                                               java.util.Map<com.android.ide.common.rendering.api.ResourceNamespace,java.util.Map<com.android.resources.ResourceType,ResourceValueMap>> resources,
                                               @Nullable
                                               com.android.ide.common.rendering.api.ResourceReference themeReference)

Creates a new ResourceResolver object.

Parameters:

resources - all resources.

themeReference - reference to the theme to be used.

Returns:

a new ResourceResolver

copy

@Nullable
public static ResourceResolver copy(@Nullable
                                              ResourceResolver original)

Creates a new ResourceResolver copied from the given instance.

Returns:

a new ResourceResolver or null if the passed instance is null

withValues

@NonNull
public static ResourceResolver withValues(@NonNull
                                                   com.android.ide.common.rendering.api.ResourceValue... values)

Creates a new ResourceResolver which contains only the given ResourceValue objects, indexed by namespace, type and name. There can be no duplicate (namespace, type, name) tuples in the input.

This method is meant for testing, where other components need to set up a simple ResourceResolver with known contents.

withValues

@NonNull
public static ResourceResolver withValues(@NonNull
                                                   java.lang.Iterable<com.android.ide.common.rendering.api.ResourceValue> values,
                                                   @Nullable
                                                   com.android.ide.common.rendering.api.ResourceReference themeReference)

Creates a new ResourceResolver which contains only the given ResourceValue objects, indexed by namespace, type and name. There can be no duplicate (namespace, type, name) tuples in the input.

This method is meant for testing, where other components need to set up a simple ResourceResolver with known contents.

setDeviceDefaults

public void setDeviceDefaults(@NonNull
                              java.lang.String deviceDefaultParent)

This will override the DeviceDefault styles so they point to the given parent styles (e.g. If "Material" is passed, Theme.DeviceDefault parent will become Theme.Material). This patches all the styles (not only themes) and takes care of the light and dark variants. If LEGACY_THEME is passed, parents will be directed to the default themes (i.e. Theme).

getTheme

@Nullable
public com.android.ide.common.rendering.api.StyleResourceValue getTheme()

getProjectResources

@Deprecated
public java.util.Map<com.android.resources.ResourceType,ResourceValueMap> getProjectResources()

Deprecated.

getFrameworkResources

@Deprecated
public java.util.Map<com.android.resources.ResourceType,ResourceValueMap> getFrameworkResources()

Deprecated.

setLogger

public void setLogger(com.android.ide.common.rendering.api.LayoutLog logger)

Overrides:

setLogger in class com.android.ide.common.rendering.api.RenderResources

getDefaultTheme

public com.android.ide.common.rendering.api.StyleResourceValue getDefaultTheme()

Overrides:

getDefaultTheme in class com.android.ide.common.rendering.api.RenderResources

applyStyle

public void applyStyle(@Nullable
                       com.android.ide.common.rendering.api.StyleResourceValue theme,
                       boolean useAsPrimary)

Overrides:

applyStyle in class com.android.ide.common.rendering.api.RenderResources

clearStyles

public void clearStyles()

Overrides:

clearStyles in class com.android.ide.common.rendering.api.RenderResources

getAllThemes

@NonNull
public java.util.List<com.android.ide.common.rendering.api.StyleResourceValue> getAllThemes()

Overrides:

getAllThemes in class com.android.ide.common.rendering.api.RenderResources

themeIsChildOfAny

public boolean themeIsChildOfAny(@NonNull
                                 com.android.ide.common.rendering.api.StyleResourceValue childTheme,
                                 @NonNull
                                 com.android.ide.common.rendering.api.StyleResourceValue... parentThemes)

Returns whether a theme is a child of at least one of the specified parents.

Parameters:

childTheme - the child theme

parentThemes - the parent themes

Returns:

true if the child theme is indeed a child theme of one of the parent themes.

Throws:

java.lang.RuntimeException - if no parent themes are specified

findItemInStyle

@Nullable
public com.android.ide.common.rendering.api.StyleItemResourceValue findItemInStyle(@NonNull
                                                                                             com.android.ide.common.rendering.api.StyleResourceValue style,
                                                                                             @NonNull
                                                                                             com.android.ide.common.rendering.api.ResourceReference attr)

Overrides:

findItemInStyle in class com.android.ide.common.rendering.api.RenderResources

getUnresolvedResource

@Nullable
public com.android.ide.common.rendering.api.ResourceValue getUnresolvedResource(@NonNull
                                                                                          com.android.ide.common.rendering.api.ResourceReference reference)

Overrides:

getUnresolvedResource in class com.android.ide.common.rendering.api.RenderResources

dereference

@Nullable
public com.android.ide.common.rendering.api.ResourceValue dereference(@NonNull
                                                                                com.android.ide.common.rendering.api.ResourceValue value)

Overrides:

dereference in class com.android.ide.common.rendering.api.RenderResources

resolveResValue

@Nullable
public com.android.ide.common.rendering.api.ResourceValue resolveResValue(@Nullable
                                                                                    com.android.ide.common.rendering.api.ResourceValue resValue)

If the given resource value contains a reference, resolves that reference to the actual value.

Overrides:

resolveResValue in class com.android.ide.common.rendering.api.RenderResources

Parameters:

resValue - the resource value to resolve

Returns:

the resolved resource value, or null if resValue is null

getParent

@Nullable
public com.android.ide.common.rendering.api.StyleResourceValue getParent(@NonNull
                                                                                   com.android.ide.common.rendering.api.StyleResourceValue style)

Overrides:

getParent in class com.android.ide.common.rendering.api.RenderResources

getChildren

@NonNull
public java.util.Collection<com.android.ide.common.rendering.api.StyleResourceValue> getChildren(@NonNull
                                                                                                          com.android.ide.common.rendering.api.StyleResourceValue style)

styleExtends

public boolean styleExtends(@NonNull
                            com.android.ide.common.rendering.api.StyleResourceValue child,
                            @NonNull
                            com.android.ide.common.rendering.api.StyleResourceValue ancestor)

getStyle

@Nullable
public com.android.ide.common.rendering.api.StyleResourceValue getStyle(@NonNull
                                                                                  com.android.ide.common.rendering.api.ResourceReference styleReference)

Overrides:

getStyle in class com.android.ide.common.rendering.api.RenderResources

isTheme

public boolean isTheme(@NonNull
                       com.android.ide.common.rendering.api.ResourceValue value,
                       @Nullable
                       java.util.Map<com.android.ide.common.rendering.api.ResourceValue,java.lang.Boolean> cache)

Checks if the given ResourceValue represents a theme.

createRecorder

public ResourceResolver createRecorder(java.util.List<com.android.ide.common.rendering.api.ResourceValue> lookupChain)

Creates a new ResourceResolver which records all resource resolution lookups into the given list. Note that it is the responsibility of the caller to clear/reset the list between subsequent lookup operations.

Parameters:

lookupChain - the list to write resource lookups into

Returns:

a new ResourceResolver

getCurrentTheme

@Deprecated
public com.android.ide.common.rendering.api.StyleResourceValue getCurrentTheme()

Deprecated. Use getDefaultTheme() or getAllThemes()

getTheme

@Deprecated
public com.android.ide.common.rendering.api.StyleResourceValue getTheme(java.lang.String name,
                                                                                    boolean frameworkTheme)

Deprecated. Use getStyle(ResourceReference)

getFrameworkResource

@Deprecated
public com.android.ide.common.rendering.api.ResourceValue getFrameworkResource(com.android.resources.ResourceType resourceType,
                                                                                           java.lang.String resourceName)

Deprecated. Use RenderResources.getResolvedResource(ResourceReference)

getProjectResource

@Deprecated
public com.android.ide.common.rendering.api.ResourceValue getProjectResource(com.android.resources.ResourceType resourceType,
                                                                                         java.lang.String resourceName)

Deprecated. Use RenderResources.getResolvedResource(ResourceReference)

findItemInTheme

@Deprecated
 @Nullable
public final com.android.ide.common.rendering.api.ResourceValue findItemInTheme(java.lang.String attrName,
                                                                                                       boolean isFrameworkAttr)

Deprecated. Use RenderResources.findItemInTheme(ResourceReference).

findItemInStyle

@Deprecated
 @Nullable
public final com.android.ide.common.rendering.api.ResourceValue findItemInStyle(com.android.ide.common.rendering.api.StyleResourceValue style,
                                                                                                       java.lang.String attrName,
                                                                                                       boolean isFrameworkAttr)

Deprecated. Use findItemInStyle(StyleResourceValue, ResourceReference).

getStyle

@Deprecated
public final com.android.ide.common.rendering.api.StyleResourceValue getStyle(java.lang.String styleName,
                                                                                          boolean isFramework)

Deprecated. Use getStyle(ResourceReference)

Returns the style matching the given name. The name should not contain any namespace prefix.

Parameters:

styleName - Name of the style. For example, "Widget.ListView.DropDown".

Returns:

the {link StyleResourceValue} for the style, or null if not found.