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

Base class for resource repository classes. Provides implementations of resource lookup methods.

Constructor Summary

Constructors

Constructor and Description
AbstractResourceRepository()

Method Summary

Modifier and Type	Method and Description
abstract void	accept(ResourceVisitor visitor) Calls the ResourceVisitor.visit(ResourceItem) method for all resources in the repository.
protected static ResourceVisitor.VisitResult	acceptByResources(java.util.Map<com.android.resources.ResourceType,com.google.common.collect.ListMultimap<java.lang.String,ResourceItem>> map, ResourceVisitor visitor) Helper method to be used by implementations of the accept(ResourceVisitor) method.
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.
protected abstract com.google.common.collect.ListMultimap<java.lang.String,ResourceItem>	getResourcesInternal(com.android.ide.common.rendering.api.ResourceNamespace namespace, com.android.resources.ResourceType resourceType) Returns the ListMultimap containing resources with the given namespace and type keyed by resource names.
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, getPublicResources, getResources

Constructor Detail

AbstractResourceRepository

public AbstractResourceRepository()

Method Detail

getResourcesInternal

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

Returns the ListMultimap containing resources with the given namespace and type keyed by resource names. Unlike getResources(ResourceNamespace, ResourceType), this method is expected to return the map directly backed by the internal resource storage, although the returned map doesn't have to be mutable.

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 abstract 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

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

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

acceptByResources

protected static ResourceVisitor.VisitResult acceptByResources(@NonNull
                                                               java.util.Map<com.android.resources.ResourceType,com.google.common.collect.ListMultimap<java.lang.String,ResourceItem>> map,
                                                               @NonNull
                                                               ResourceVisitor visitor)

Helper method to be used by implementations of the accept(ResourceVisitor) method.