com.android.ide.common.resources

Interface ResourceRepository

All Known Subinterfaces:

SingleNamespaceResourceRepository

All Known Implementing Classes:

AbstractResourceRepository, TestResourceRepository

public interface ResourceRepository

Common interface for all Android resource repositories.

Method Summary

Modifier and Type	Method and Description
ResourceVisitor.VisitResult	accept(ResourceVisitor visitor) Calls the ResourceVisitor.visit(ResourceItem) method for all resources in the repository.
default java.util.List<ResourceItem>	getAllResources() Returns a list of all resources in the repository.
java.util.Collection<SingleNamespaceResourceRepository>	getLeafResourceRepositories() Returns all leaf resource repositories contained in this repository, or this repository itself, if it does not contain any other repositories and implements SingleNamespaceResourceRepository.
java.util.Set<com.android.ide.common.rendering.api.ResourceNamespace>	getNamespaces() Returns the namespaces that the resources in this repository belong to.
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.
default java.util.List<ResourceItem>	getResources(com.android.ide.common.rendering.api.ResourceReference reference)
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.

Method Detail

getResources

@NonNull
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)

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

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
default java.util.List<ResourceItem> getResources(@NonNull
                                                           com.android.ide.common.rendering.api.ResourceReference reference)

getResources

@NonNull
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)

Returns the resources with the given namespace, type and 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

getResources

@NonNull
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)

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

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

@NonNull
ResourceVisitor.VisitResult accept(@NonNull
                                            ResourceVisitor visitor)

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.

Parameters:

visitor - the visitor object

Returns:

the last value returned by the visitor, i.e. ResourceVisitor.VisitResult.ABORT if the method finished because the visitor requested it or ResourceVisitor.VisitResult.CONTINUE otherwise.

getAllResources

@NonNull
default java.util.List<ResourceItem> getAllResources()

Returns a list of all resources in the repository.

This method is expensive. Consider using accept(ResourceVisitor) instead.

Returns:

a list of all resources in the repository

getPublicResources

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

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

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

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

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

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

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

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

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
java.util.Set<com.android.resources.ResourceType> getResourceTypes(@NonNull
                                                                            com.android.ide.common.rendering.api.ResourceNamespace namespace)

Returns types of the resources in the given namespace.

Parameters:

namespace - the namespace to get resource types for

Returns:

the set of resource types

getNamespaces

@NonNull
java.util.Set<com.android.ide.common.rendering.api.ResourceNamespace> getNamespaces()

Returns the namespaces that the resources in this repository belong to. The returned set may include namespaces that don't contain any resource items.

getLeafResourceRepositories

@NonNull
java.util.Collection<SingleNamespaceResourceRepository> getLeafResourceRepositories()

Returns all leaf resource repositories contained in this repository, or this repository itself, if it does not contain any other repositories and implements SingleNamespaceResourceRepository.