com.android.ide.common.rendering.api

Class ResourceReference

java.lang.Object

com.android.ide.common.rendering.api.ResourceReference

All Implemented Interfaces:

java.io.Serializable

@Immutable
public final class ResourceReference
extends java.lang.Object
implements java.io.Serializable

A resource reference, contains the namespace, type and name. Can be used to look for resources in a resource repository.

This is an immutable class.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ResourceReference(ResourceNamespace namespace, ResourceType resourceType, java.lang.String name)
ResourceReference(ResourceType type, java.lang.String name, boolean isFramework) Deprecated.
ResourceReference(java.lang.String name, boolean isFramework) Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getName() Returns the name of the resource, as defined in the XML.
ResourceNamespace	getNamespace()
java.lang.String	getQualifiedName() If the package name of the namespace is not null, returns the name of the resource prefixed by the package name with a colon separator.
ResourceUrl	getRelativeResourceUrl(ResourceNamespace context) Returns a ResourceUrl that can be used to refer to this resource from the given namespace.
ResourceUrl	getRelativeResourceUrl(ResourceNamespace context, ResourceNamespace.Resolver resolver) Returns a ResourceUrl that can be used to refer to this resource from the given namespace.
ResourceType	getResourceType()
ResourceUrl	getResourceUrl()
int	hashCode()
boolean	isFramework() Deprecated. all namespaces should be handled not just "android:".
static ResourceReference	style(ResourceNamespace namespace, java.lang.String name) A shorthand for creating a ResourceType.STYLE resource reference.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ResourceReference

public ResourceReference(@NonNull
                         ResourceNamespace namespace,
                         @NonNull
                         ResourceType resourceType,
                         @NonNull
                         java.lang.String name)

ResourceReference

@Deprecated
public ResourceReference(@NonNull
                                     java.lang.String name,
                                     boolean isFramework)

Deprecated.

Used by layoutlib still. TODO(namespaces): remove this.

ResourceReference

@Deprecated
public ResourceReference(@NonNull
                                     ResourceType type,
                                     @NonNull
                                     java.lang.String name,
                                     boolean isFramework)

Deprecated.

Method Detail

style

public static ResourceReference style(@NonNull
                                      ResourceNamespace namespace,
                                      @NonNull
                                      java.lang.String name)

A shorthand for creating a ResourceType.STYLE resource reference.

getName

@NonNull
public java.lang.String getName()

Returns the name of the resource, as defined in the XML.

getQualifiedName

public java.lang.String getQualifiedName()

If the package name of the namespace is not null, returns the name of the resource prefixed by the package name with a colon separator. Otherwise returns the name of the resource.

getResourceType

@NonNull
public ResourceType getResourceType()

getNamespace

@NonNull
public ResourceNamespace getNamespace()

isFramework

@Deprecated
public final boolean isFramework()

Deprecated. all namespaces should be handled not just "android:".

Returns whether the resource is a framework resource (true) or a project resource (false).

getResourceUrl

@NonNull
public ResourceUrl getResourceUrl()

getRelativeResourceUrl

@NonNull
public ResourceUrl getRelativeResourceUrl(@NonNull
                                                   ResourceNamespace context)

Returns a ResourceUrl that can be used to refer to this resource from the given namespace. This means the namespace part of the ResourceUrl will be null if the context namespace is the same as the namespace of this resource.

This method assumes no namespace prefixes (aliases) are defined, so the returned ResourceUrl will use the full package name of the target namespace, if necessary. Most use cases should attempt to call the overloaded method instead and provide a ResourceNamespace.Resolver from the XML element where the ResourceUrl will be used.

See Also:

getRelativeResourceUrl(ResourceNamespace, ResourceNamespace.Resolver)

getRelativeResourceUrl

@NonNull
public ResourceUrl getRelativeResourceUrl(@NonNull
                                                   ResourceNamespace context,
                                                   @NonNull
                                                   ResourceNamespace.Resolver resolver)

Returns a ResourceUrl that can be used to refer to this resource from the given namespace. This means the namespace part of the ResourceUrl will be null if the context namespace is the same as the namespace of this resource.

This method uses the provided ResourceNamespace.Resolver to find the short prefix that can be used to refer to the target namespace. If it is not found, the full package name is used.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object