com.android.ide.common.resources

Class AbstractResourceRepository

java.lang.Object

com.android.ide.common.resources.AbstractResourceRepository

Direct Known Subclasses:

MergerResourceRepository

public abstract class AbstractResourceRepository
extends java.lang.Object

Wrapper around a ResourceTable that:

• May compute cells in the table on-demand.
• May change in the background, if underlying files or other sources of data have changed. Because of that access should be synchronized on the ITEM_MAP_LOCK object.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Object	ITEM_MAP_LOCK The lock used to protect map access.
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.

Constructor Summary

Constructors

Constructor and Description
AbstractResourceRepository()

Method Summary

Modifier and Type	Method and Description
java.util.List<ResourceItem>	getAllResourceItems()
com.google.common.collect.ImmutableSet<com.android.resources.ResourceType>	getAvailableResourceTypes(com.android.ide.common.rendering.api.ResourceNamespace namespace)
com.google.common.collect.Table<com.android.ide.common.rendering.api.ResourceNamespace,com.android.resources.ResourceType,ResourceValueMap>	getConfiguredResources(FolderConfiguration referenceConfig) Returns the resources values matching a given FolderConfiguration.
ResourceValueMap	getConfiguredResources(com.android.ide.common.rendering.api.ResourceNamespace namespace, com.android.resources.ResourceType type, FolderConfiguration referenceConfig) Returns a map of (resource name, resource value) for the given ResourceType.
com.android.ide.common.rendering.api.ResourceValue	getConfiguredValue(com.android.resources.ResourceType type, java.lang.String name, FolderConfiguration referenceConfig)
protected abstract ResourceTable	getFullTable() Returns the fully computed ResourceTable for this repository.
ResourceTable	getItems()
java.util.Collection<java.lang.String>	getItemsOfType(com.android.ide.common.rendering.api.ResourceNamespace namespace, com.android.resources.ResourceType type)
java.util.Collection<java.lang.String>	getItemsOfType(com.android.resources.ResourceType type) Deprecated. Use getItemsOfType(ResourceNamespace, ResourceType) instead.
void	getLeafResourceRepositories(java.util.Collection<AbstractResourceRepository> result) Returns all leaf resource repositories contained in this resource repository including this repository itself, if it does not contain any other repositories.
java.util.SortedSet<LocaleQualifier>	getLocales() Returns the sorted list of languages used in the resources.
protected com.google.common.collect.ListMultimap<java.lang.String,ResourceItem>	getMap(com.android.ide.common.rendering.api.ResourceNamespace namespace, com.android.resources.ResourceType type)
protected abstract com.google.common.collect.ListMultimap<java.lang.String,ResourceItem>	getMap(com.android.ide.common.rendering.api.ResourceNamespace namespace, com.android.resources.ResourceType type, boolean create)
abstract java.util.Set<com.android.ide.common.rendering.api.ResourceNamespace>	getNamespaces()
java.util.Collection<ResourceItem>	getPublicResourcesOfType(com.android.resources.ResourceType type) Returns a collection of public resource items matching a given resource type.
java.util.List<ResourceItem>	getResourceItem(com.android.resources.ResourceType resourceType, java.lang.String resourceName) Deprecated. Use getResourceItems(ResourceNamespace, ResourceType, String) instead.
java.util.List<ResourceItem>	getResourceItems(com.android.ide.common.rendering.api.ResourceNamespace namespace, com.android.resources.ResourceType resourceType) Returns the resources with the given namespace and type.
java.util.List<ResourceItem>	getResourceItems(com.android.ide.common.rendering.api.ResourceNamespace namespace, com.android.resources.ResourceType resourceType, java.util.function.Predicate<ResourceItem> filter) Returns the resources with the given namespace, type and with a name satisfying the given predicate.
java.util.List<ResourceItem>	getResourceItems(com.android.ide.common.rendering.api.ResourceNamespace namespace, com.android.resources.ResourceType resourceType, java.lang.String resourceName)
java.util.List<ResourceItem>	getResourceItems(com.android.ide.common.rendering.api.ResourceReference reference)
boolean	hasResourceItem(com.android.ide.common.rendering.api.ResourceNamespace namespace, com.android.resources.ResourceType resourceType, java.lang.String resourceName) Returns true if this resource repository contains a resource of the given name.
boolean	hasResourceItem(com.android.resources.ResourceType resourceType, java.lang.String resourceName) Deprecated. Use getResourceItems(ResourceNamespace, ResourceType, String) or hasResourceItem(ResourceNamespace, ResourceType, String) instead
boolean	hasResourceItem(java.lang.String url) Returns true if this resource repository contains a resource of the given name.
boolean	hasResourcesOfType(com.android.ide.common.rendering.api.ResourceNamespace namespace, com.android.resources.ResourceType resourceType) Returns whether the repository has resources of a given ResourceType.
boolean	hasResourcesOfType(com.android.resources.ResourceType resourceType) Returns whether the repository has resources of a given ResourceType.

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

ITEM_MAP_LOCK

public static final java.lang.Object ITEM_MAP_LOCK

The lock used to protect map access.

In the IDE, this needs to be obtained AFTER the IDE read/write lock, to avoid deadlocks (most readers of the repository system execute in a read action, so obtaining the locks in opposite order results in deadlocks).

Constructor Detail

AbstractResourceRepository

public AbstractResourceRepository()

Method Detail

getLeafResourceRepositories

public void getLeafResourceRepositories(@NonNull
                                        java.util.Collection<AbstractResourceRepository> result)

Returns all leaf resource repositories contained in this resource repository including this repository itself, if it does not contain any other repositories.

Parameters:

result - the collection to add the leaf repositories to

getFullTable

@NonNull
 @GuardedBy(value="AbstractResourceRepository.ITEM_MAP_LOCK")
protected abstract ResourceTable getFullTable()

Returns the fully computed ResourceTable for this repository.

The returned object should be accessed only while holding ITEM_MAP_LOCK.

getMap

@Nullable
 @GuardedBy(value="AbstractResourceRepository.ITEM_MAP_LOCK")
protected abstract com.google.common.collect.ListMultimap<java.lang.String,ResourceItem> getMap(@NonNull
                                                                                                                                                                        com.android.ide.common.rendering.api.ResourceNamespace namespace,
                                                                                                                                                                        @NonNull
                                                                                                                                                                        com.android.resources.ResourceType type,
                                                                                                                                                                        boolean create)

getNamespaces

@NonNull
 @GuardedBy(value="AbstractResourceRepository.ITEM_MAP_LOCK")
public abstract java.util.Set<com.android.ide.common.rendering.api.ResourceNamespace> getNamespaces()

getMap

@NonNull
 @GuardedBy(value="AbstractResourceRepository.ITEM_MAP_LOCK")
protected final com.google.common.collect.ListMultimap<java.lang.String,ResourceItem> getMap(@NonNull
                                                                                                                                                                    com.android.ide.common.rendering.api.ResourceNamespace namespace,
                                                                                                                                                                    @NonNull
                                                                                                                                                                    com.android.resources.ResourceType type)

getItems

@NonNull
 @GuardedBy(value="AbstractResourceRepository.ITEM_MAP_LOCK")
public ResourceTable getItems()

getAllResourceItems

@NonNull
public final java.util.List<ResourceItem> getAllResourceItems()

getResourceItem

@Deprecated
 @Nullable
public java.util.List<ResourceItem> getResourceItem(@NonNull
                                                                           com.android.resources.ResourceType resourceType,
                                                                           @NonNull
                                                                           java.lang.String resourceName)

Deprecated. Use getResourceItems(ResourceNamespace, ResourceType, String) instead.

getResourceItems

@NonNull
public java.util.List<ResourceItem> getResourceItems(@NonNull
                                                              com.android.ide.common.rendering.api.ResourceNamespace namespace,
                                                              @NonNull
                                                              com.android.resources.ResourceType resourceType,
                                                              @NonNull
                                                              java.lang.String resourceName)

getResourceItems

@NonNull
public java.util.List<ResourceItem> getResourceItems(@NonNull
                                                              com.android.ide.common.rendering.api.ResourceNamespace namespace,
                                                              @NonNull
                                                              com.android.resources.ResourceType resourceType,
                                                              @NonNull
                                                              java.util.function.Predicate<ResourceItem> filter)

Returns the resources with the given namespace, type and with a name satisfying the given predicate.

Parameters:

namespace - the namespace of the resources to return

resourceType - the type of the resources to return

filter - the predicate for checking resource items

Returns:

the resources matching the namespace, type, and satisfying the name filter

getResourceItems

@NonNull
public java.util.List<ResourceItem> getResourceItems(@NonNull
                                                              com.android.ide.common.rendering.api.ResourceNamespace namespace,
                                                              @NonNull
                                                              com.android.resources.ResourceType resourceType)

Returns the resources with the given namespace and type.

Parameters:

namespace - the namespace of the resources to return

resourceType - the type of the resources to return

Returns:

the resources matching the namespace and type

getResourceItems

@NonNull
public java.util.List<ResourceItem> getResourceItems(@NonNull
                                                              com.android.ide.common.rendering.api.ResourceReference reference)

getItemsOfType

@Deprecated
 @NonNull
public final java.util.Collection<java.lang.String> getItemsOfType(@NonNull
                                                                                         com.android.resources.ResourceType type)

Deprecated. Use getItemsOfType(ResourceNamespace, ResourceType) instead.

getItemsOfType

@NonNull
public java.util.Collection<java.lang.String> getItemsOfType(@NonNull
                                                                      com.android.ide.common.rendering.api.ResourceNamespace namespace,
                                                                      @NonNull
                                                                      com.android.resources.ResourceType type)

getPublicResourcesOfType

@NonNull
public java.util.Collection<ResourceItem> getPublicResourcesOfType(@NonNull
                                                                            com.android.resources.ResourceType type)

Returns a collection of public resource items matching a given resource type.

This implementation returns an empty collection. Subclasses may override this behavior.

Parameters:

type - the type of the resources to return

Returns:

a collection of items, possibly empty.

hasResourceItem

public boolean hasResourceItem(@NonNull
                               java.lang.String url)

Returns true if this resource repository contains a resource of the given name.

Parameters:

url - the resource URL

Returns:

true if the resource is known

hasResourceItem

@Deprecated
public boolean hasResourceItem(@NonNull
                                           com.android.resources.ResourceType resourceType,
                                           @NonNull
                                           java.lang.String resourceName)

Deprecated. Use getResourceItems(ResourceNamespace, ResourceType, String) or hasResourceItem(ResourceNamespace, ResourceType, String) instead

hasResourceItem

public boolean hasResourceItem(@NonNull
                               com.android.ide.common.rendering.api.ResourceNamespace namespace,
                               @NonNull
                               com.android.resources.ResourceType resourceType,
                               @NonNull
                               java.lang.String resourceName)

Returns true if this resource repository contains a resource of the given name.

Parameters:

namespace - the namespace of the resource to look up

resourceType - the type of resource to look up

resourceName - the name of the resource

Returns:

true if the resource is known

hasResourcesOfType

public boolean hasResourcesOfType(@NonNull
                                  com.android.resources.ResourceType resourceType)

Returns whether the repository has resources of a given ResourceType.

Parameters:

resourceType - the type of resource to check.

Returns:

true if the repository contains resources of the given type, false otherwise.

hasResourcesOfType

public boolean hasResourcesOfType(@NonNull
                                  com.android.ide.common.rendering.api.ResourceNamespace namespace,
                                  @NonNull
                                  com.android.resources.ResourceType resourceType)

Returns whether the repository has resources of a given ResourceType.

Do not call this method if you you are going to call getItemsOfType(ResourceNamespace, ResourceType) or getResourceItems(ResourceNamespace, ResourceType) immediately after.

Parameters:

resourceType - the type of resource to check.

Returns:

true if the repository contains resources of the given type, false otherwise.

getAvailableResourceTypes

@NonNull
public com.google.common.collect.ImmutableSet<com.android.resources.ResourceType> getAvailableResourceTypes(@NonNull
                                                                                                                     com.android.ide.common.rendering.api.ResourceNamespace namespace)

getConfiguredResources

@NonNull
public com.google.common.collect.Table<com.android.ide.common.rendering.api.ResourceNamespace,com.android.resources.ResourceType,ResourceValueMap> getConfiguredResources(@NonNull
                                                                                                                                                                                   FolderConfiguration referenceConfig)

Returns the resources values matching a given FolderConfiguration.

Parameters:

referenceConfig - the configuration that each value must match.

Returns:

a Table with one row for every namespace present in this repository, where every row contains an entry for all resource types.

getConfiguredResources

@NonNull
public ResourceValueMap getConfiguredResources(@NonNull
                                                        com.android.ide.common.rendering.api.ResourceNamespace namespace,
                                                        @NonNull
                                                        com.android.resources.ResourceType type,
                                                        @NonNull
                                                        FolderConfiguration referenceConfig)

Returns a map of (resource name, resource value) for the given ResourceType.

The values returned are taken from the resource files best matching a given FolderConfiguration.

Parameters:

namespace - namespaces of the resources

type - the type of the resources.

referenceConfig - the configuration to best match.

getConfiguredValue

@Nullable
public com.android.ide.common.rendering.api.ResourceValue getConfiguredValue(@NonNull
                                                                                       com.android.resources.ResourceType type,
                                                                                       @NonNull
                                                                                       java.lang.String name,
                                                                                       @NonNull
                                                                                       FolderConfiguration referenceConfig)

getLocales

@NonNull
public java.util.SortedSet<LocaleQualifier> getLocales()

Returns the sorted list of languages used in the resources.