com.android.ide.common.resources

Class AbstractResourceRepository

java.lang.Object

com.android.ide.common.resources.AbstractResourceRepository

All Implemented Interfaces:

ResourceRepository

Direct Known Subclasses:

TestResourceRepository

public abstract class AbstractResourceRepository
extends java.lang.Object
implements ResourceRepository

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
void	accept(ResourceVisitor visitor) Calls the ResourceVisitor.visit(ResourceItem) method for all resources in the repository.
protected abstract ResourceTable	getFullTable() Returns the fully computed ResourceTable for this repository.
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)
java.util.Collection<ResourceItem>	getPublicResources(com.android.ide.common.rendering.api.ResourceNamespace namespace, com.android.resources.ResourceType type) Returns a collection of public resource items with the given namespace and type.
com.google.common.collect.ListMultimap<java.lang.String,ResourceItem>	getResources(com.android.ide.common.rendering.api.ResourceNamespace namespace, com.android.resources.ResourceType resourceType) Returns the resources with the given namespace and type keyed by resource names.
java.util.List<ResourceItem>	getResources(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 satisfying the given predicate.
java.util.List<ResourceItem>	getResources(com.android.ide.common.rendering.api.ResourceNamespace namespace, com.android.resources.ResourceType resourceType, java.lang.String resourceName) Returns the resources with the given namespace, type and name.
java.util.Set<com.android.resources.ResourceType>	getResourceTypes(com.android.ide.common.rendering.api.ResourceNamespace namespace) Returns types of the resources in the given namespace.
boolean	hasResources(com.android.ide.common.rendering.api.ResourceNamespace namespace, com.android.resources.ResourceType resourceType) Checks if the repository contains resources with the given namespace and type.
boolean	hasResources(com.android.ide.common.rendering.api.ResourceNamespace namespace, com.android.resources.ResourceType resourceType, java.lang.String resourceName) Checks if the repository contains resources with the given namespace, type and name.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.android.ide.common.resources.ResourceRepository

getAllResources, getLeafResourceRepositories, getNamespaces, getResources

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

getFullTable

@GuardedBy(value="AbstractResourceRepository.ITEM_MAP_LOCK")
 @NonNull
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

@GuardedBy(value="AbstractResourceRepository.ITEM_MAP_LOCK")
 @Nullable
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)

getMap

@GuardedBy(value="AbstractResourceRepository.ITEM_MAP_LOCK")
 @NonNull
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)

getResources

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

Description copied from interface: ResourceRepository

Returns the resources with the given namespace, type and name.

Specified by:

getResources in interface ResourceRepository

Parameters:

namespace - the namespace of the resources to return

resourceType - the type of the resources to return

resourceName - the bane of the resources to return

Returns:

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

getResources

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

Description copied from interface: ResourceRepository

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

Specified by:

getResources in interface ResourceRepository

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

getResources

@NonNull
public com.google.common.collect.ListMultimap<java.lang.String,ResourceItem> getResources(@NonNull
                                                                                                   com.android.ide.common.rendering.api.ResourceNamespace namespace,
                                                                                                   @NonNull
                                                                                                   com.android.resources.ResourceType resourceType)

Description copied from interface: ResourceRepository

Returns the resources with the given namespace and type keyed by resource names.

Specified by:

getResources in interface ResourceRepository

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

accept

public void accept(@NonNull
                   ResourceVisitor visitor)

Description copied from interface: ResourceRepository

Calls the ResourceVisitor.visit(ResourceItem) method for all resources in the repository. The visitor should not perform any long running operations or operations involving locks.

Specified by:

accept in interface ResourceRepository

Parameters:

visitor - the visitor object

getPublicResources

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

Description copied from interface: ResourceRepository

Returns a collection of public resource items with the given namespace and type.

Specified by:

getPublicResources in interface ResourceRepository

Parameters:

namespace - the namespace of the resources to return

type - the type of the resources to return

Returns:

a collection of items, possibly empty.

hasResources

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

Description copied from interface: ResourceRepository

Checks if the repository contains resources with the given namespace, type and name.

Specified by:

hasResources in interface ResourceRepository

Parameters:

namespace - the namespace of the resources to check

resourceType - the type of the resources to check

resourceName - the name of the resources to check

Returns:

true if there is at least one resource with the given namespace, type and name in the repository

hasResources

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

Description copied from interface: ResourceRepository

Checks if the repository contains resources with the given namespace and type.

Specified by:

hasResources in interface ResourceRepository

Parameters:

namespace - the namespace of the resources to check

resourceType - the type of the resources to check

Returns:

true if there is at least one resource with the given namespace and type in the repository

getResourceTypes

@NonNull
public java.util.Set<com.android.resources.ResourceType> getResourceTypes(@NonNull
                                                                                   com.android.ide.common.rendering.api.ResourceNamespace namespace)

Description copied from interface: ResourceRepository

Returns types of the resources in the given namespace.

Specified by:

getResourceTypes in interface ResourceRepository

Parameters:

namespace - the namespace to get resource types for

Returns:

the set of resource types