com.android.ide.common.res2

Class AbstractResourceRepository

java.lang.Object

com.android.ide.common.res2.AbstractResourceRepository

Direct Known Subclasses:

ResourceRepository

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.

Constructor Summary

Constructors

Constructor and Description
AbstractResourceRepository()

Method Summary

Modifier and Type	Method and Description
java.util.List<ResourceItem>	getAllResourceItems()
java.util.List<com.android.resources.ResourceType>	getAvailableResourceTypes()
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)
java.util.SortedSet<java.lang.String>	getLanguages() Returns the sorted list of languages used in the resources.
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)
ResourceFile	getMatchingFile(java.lang.String name, com.android.resources.ResourceType type, FolderConfiguration config) Returns the ResourceFile matching the given name, ResourceType and configuration.
java.util.List<ResourceFile>	getMatchingFiles(java.lang.String name, com.android.resources.ResourceType type, FolderConfiguration config) Returns a list of ResourceFile matching the given name, ResourceType and configuration.
abstract java.util.Set<com.android.ide.common.rendering.api.ResourceNamespace>	getNamespaces()
java.util.SortedSet<java.lang.String>	getRegions(java.lang.String currentLanguage) Returns the sorted list of regions used in the resources with the given language.
java.util.List<ResourceItem>	getResourceItem(com.android.resources.ResourceType resourceType, java.lang.String resourceName) Deprecated.
java.util.List<ResourceItem>	getResourceItems(com.android.ide.common.rendering.api.ResourceNamespace namespace, com.android.resources.ResourceType resourceType, java.lang.String resourceName)
boolean	hasResourceItem(com.android.resources.ResourceType resourceType, java.lang.String resourceName) Returns true if this resource repository contains a resource of the given name.
boolean	hasResourceItem(java.lang.String url) Returns true if this resource repository contains a resource of the given name.
boolean	hasResourcesOfType(com.android.resources.ResourceType resourceType) Returns whether the repository has resources of a given ResourceType.
boolean	isFramework() Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

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

isFramework

@Deprecated
public final boolean isFramework()

Deprecated.

For now we don't use AbstractResourceRepository for framework resources, but eventually we will start at which point a single repository may contain both framework and app resources. The "truth" lies in the namespace of the ResourceItems. Soon we'll get rid of this method.

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

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

Deprecated.

See Also:

getResourceItems(ResourceNamespace, ResourceType, String)

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)

getItemsOfType

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

getItemsOfType

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

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

public boolean hasResourceItem(@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:

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.

getAvailableResourceTypes

@NonNull
public java.util.List<com.android.resources.ResourceType> getAvailableResourceTypes()

getMatchingFile

@Nullable
public ResourceFile getMatchingFile(@NonNull
                                              java.lang.String name,
                                              @NonNull
                                              com.android.resources.ResourceType type,
                                              @NonNull
                                              FolderConfiguration config)

Returns the ResourceFile matching the given name, ResourceType and configuration.

This only works with files generating one resource named after the file (for instance, layouts, bitmap based drawable, xml, anims).

Parameters:

name - the resource name

type - the folder type search for

config - the folder configuration to match for

Returns:

the matching file or null if no match was found.

getMatchingFiles

@NonNull
public java.util.List<ResourceFile> getMatchingFiles(@NonNull
                                                              java.lang.String name,
                                                              @NonNull
                                                              com.android.resources.ResourceType type,
                                                              @NonNull
                                                              FolderConfiguration config)

Returns a list of ResourceFile matching the given name, ResourceType and configuration. This ignores the qualifiers which are missing from the configuration.

This only works with files generating one resource named after the file (for instance, layouts, bitmap based drawable, xml, anims).

Parameters:

name - the resource name

type - the folder type search for

config - the folder configuration to match for

See Also:

getMatchingFile(String, ResourceType, FolderConfiguration)

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)

getLanguages

@NonNull
public java.util.SortedSet<java.lang.String> getLanguages()

Returns the sorted list of languages used in the resources.

getLocales

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

Returns the sorted list of languages used in the resources.

getRegions

@NonNull
public java.util.SortedSet<java.lang.String> getRegions(@NonNull
                                                                 java.lang.String currentLanguage)

Returns the sorted list of regions used in the resources with the given language.

Parameters:

currentLanguage - the current language the region must be associated with.