com.android.resources

Class ResourceUrl

java.lang.Object

com.android.resources.ResourceUrl

@Immutable
public class ResourceUrl
extends java.lang.Object

A ResourceUrl represents a parsed resource url such as @string/foo or ?android:attr/bar

Field Summary

Fields

Modifier and Type	Field and Description
boolean	create Whether an id resource is of the form @+id rather than just @id
boolean	framework If true, the resource is in the android: framework
java.lang.String	name Name of resource
java.lang.String	namespace The namespace, or null if it's in the project namespace
boolean	theme Whether this is a theme resource reference
ResourceType	type Type of resource

Method Summary

Modifier and Type	Method and Description
ResourceUrl	asThemeUrl() Creates a copy of this ResourceUrl with the theme field set to true.
static ResourceUrl	create(ResourceType type, java.lang.String name, boolean framework) Deprecated. This factory method is used where we have no way of knowing the namespace. We need to migrate every call site to the other factory method that takes a namespace.
static ResourceUrl	create(java.lang.String namespace, ResourceType type, java.lang.String name) Creates a new resource URL, representing "@namespace:type/name".
boolean	equals(java.lang.Object o)
int	hashCode()
boolean	hasValidName() Checks whether this resource has a valid name.
static boolean	isNullOrEmpty(java.lang.String url) Returns if the resource url is @null, @empty or @undefined.
static ResourceUrl	parse(java.lang.String url) Return the resource type of the given url, and the resource name
static ResourceUrl	parse(java.lang.String url, boolean forceFramework) Return the resource type of the given url, and the resource name.
java.lang.String	toString()
ResourceUrl	withFramework(boolean isFramework) Creates a copy of this ResourceUrl with the framework field set to the given value.

Methods inherited from class java.lang.Object

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

Field Detail

type

@NonNull
public final ResourceType type

Type of resource

name

@NonNull
public final java.lang.String name

Name of resource

namespace

@Nullable
public final java.lang.String namespace

The namespace, or null if it's in the project namespace

framework

public final boolean framework

If true, the resource is in the android: framework

create

public final boolean create

Whether an id resource is of the form @+id rather than just @id

theme

public final boolean theme

Whether this is a theme resource reference

Method Detail

create

@Deprecated
public static ResourceUrl create(@NonNull
                                             ResourceType type,
                                             @NonNull
                                             java.lang.String name,
                                             boolean framework)

Deprecated. This factory method is used where we have no way of knowing the namespace. We need to migrate every call site to the other factory method that takes a namespace.

Creates a new resource URL, representing "@type/name" or "@android:type/name".

Parameters:

type - the resource type

name - the name

framework - whether it's a framework resource

See Also:

parse(String)

create

public static ResourceUrl create(@Nullable
                                 java.lang.String namespace,
                                 @NonNull
                                 ResourceType type,
                                 @NonNull
                                 java.lang.String name)

Creates a new resource URL, representing "@namespace:type/name".

Parameters:

namespace - the resource namespace

type - the resource type

name - the name

See Also:

parse(String)

parse

@Nullable
public static ResourceUrl parse(@NonNull
                                          java.lang.String url)

Return the resource type of the given url, and the resource name

Parameters:

url - the resource url to be parsed

Returns:

a pair of the resource type and the resource name

parse

@Nullable
public static ResourceUrl parse(@NonNull
                                          java.lang.String url,
                                          boolean forceFramework)

Return the resource type of the given url, and the resource name.

Parameters:

url - the resource url to be parsed

forceFramework - force the returned value to be a framework resource.

Returns:

a pair of the resource type and the resource name

isNullOrEmpty

public static boolean isNullOrEmpty(@NonNull
                                    java.lang.String url)

Returns if the resource url is @null, @empty or @undefined.

hasValidName

public boolean hasValidName()

Checks whether this resource has a valid name. Used when parsing data that isn't necessarily known to be a valid resource; for example, "?attr/hello world"

withFramework

@NonNull
public ResourceUrl withFramework(boolean isFramework)

Creates a copy of this ResourceUrl with the framework field set to the given value.

asThemeUrl

@NonNull
public ResourceUrl asThemeUrl()

Creates a copy of this ResourceUrl with the theme field set to true.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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