com.android.ide.common.rendering.api

Class ResourceValue

java.lang.Object

com.android.ide.common.rendering.api.ResourceValue

Direct Known Subclasses:

ArrayResourceValue, AttrResourceValue, DeclareStyleableResourceValue, DensityBasedResourceValue, ItemResourceValue, PluralsResourceValue, SampleDataResourceValue, StyleResourceValue, TextResourceValue

public class ResourceValue
extends java.lang.Object

Represents an android resource with a name and a string value.

Field Summary

Fields

Modifier and Type	Field and Description
protected ResourceNamespace.Resolver	mNamespaceResolver

Constructor Summary

Constructors

Constructor and Description
ResourceValue(ResourceNamespace namespace, ResourceType type, java.lang.String name, java.lang.String value)
ResourceValue(ResourceNamespace namespace, ResourceType type, java.lang.String name, java.lang.String value, java.lang.String libraryName)
ResourceValue(ResourceReference reference, java.lang.String value)
ResourceValue(ResourceReference reference, java.lang.String value, java.lang.String libraryName)
ResourceValue(ResourceType type, java.lang.String name, java.lang.String value, boolean isFramework) Deprecated. Use ResourceValue(ResourceType, String, String, boolean)

Method Summary

Modifier and Type	Method and Description
ResourceReference	asReference()
boolean	equals(java.lang.Object o)
java.lang.String	getLibraryName() Returns the name of the library where this resource was found or null if it is not from a library.
java.lang.String	getName()
ResourceNamespace	getNamespace()
ResourceNamespace.Resolver	getNamespaceResolver()
java.lang.String	getRawXmlValue() Similar to getValue(), but returns the raw XML value.
ResourceReference	getReference() If this ResourceValue references another one, returns a ResourceReference to it, otherwise null.
ResourceType	getResourceType()
ResourceUrl	getResourceUrl()
java.lang.String	getValue() Returns the value of the resource, as defined in the XML.
int	hashCode()
boolean	isFramework()
boolean	isUserDefined() Returns true if the resource is user defined.
void	replaceWith(ResourceValue value) Sets the value from another resource.
void	setNamespaceLookup(ResourceNamespace.Resolver resolver) Deprecated.
void	setNamespaceResolver(ResourceNamespace.Resolver resolver) Specifies logic used to resolve namespace aliases for values that come from XML files.
void	setValue(java.lang.String value) Sets the value of the resource.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

mNamespaceResolver

@NonNull
protected ResourceNamespace.Resolver mNamespaceResolver

Constructor Detail

ResourceValue

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

Deprecated. Use ResourceValue(ResourceType, String, String, boolean)

Constructor still used by layoutlib. Remove ASAP.

ResourceValue

public ResourceValue(@NonNull
                     ResourceReference reference,
                     @Nullable
                     java.lang.String value,
                     @Nullable
                     java.lang.String libraryName)

ResourceValue

public ResourceValue(@NonNull
                     ResourceReference reference,
                     @Nullable
                     java.lang.String value)

ResourceValue

public ResourceValue(@NonNull
                     ResourceNamespace namespace,
                     @NonNull
                     ResourceType type,
                     @NonNull
                     java.lang.String name,
                     @Nullable
                     java.lang.String value)

ResourceValue

public ResourceValue(@NonNull
                     ResourceNamespace namespace,
                     @NonNull
                     ResourceType type,
                     @NonNull
                     java.lang.String name,
                     @Nullable
                     java.lang.String value,
                     @Nullable
                     java.lang.String libraryName)

Method Detail

getResourceType

@NonNull
public ResourceType getResourceType()

getNamespace

@NonNull
public ResourceNamespace getNamespace()

getName

@NonNull
public java.lang.String getName()

getLibraryName

@Nullable
public java.lang.String getLibraryName()

Returns the name of the library where this resource was found or null if it is not from a library.

isUserDefined

public boolean isUserDefined()

Returns true if the resource is user defined.

isFramework

public boolean isFramework()

getValue

@Nullable
public java.lang.String getValue()

Returns the value of the resource, as defined in the XML. This can be null, for example for instances of StyleResourceValue.

asReference

@NonNull
public ResourceReference asReference()

getResourceUrl

@NonNull
public ResourceUrl getResourceUrl()

getReference

@Nullable
public ResourceReference getReference()

If this ResourceValue references another one, returns a ResourceReference to it, otherwise null.

This method should be called before inspecting the textual value (getValue()), as it handles namespaces correctly.

getRawXmlValue

public java.lang.String getRawXmlValue()

Similar to getValue(), but returns the raw XML value. This is usually the same as getValue, but with a few exceptions. For example, for markup strings, you can have * <string name="markup">This is <b>bold</b></string>. Here, getValue() will return "This is bold" -- e.g. just the plain text flattened. However, this method will return "This is <b>bold</b>", which preserves the XML markup elements.

setValue

public void setValue(@Nullable
                     java.lang.String value)

Sets the value of the resource.

Parameters:

value - the new value

replaceWith

public void replaceWith(ResourceValue value)

Sets the value from another resource.

Parameters:

value - the resource value

getNamespaceResolver

@NonNull
public ResourceNamespace.Resolver getNamespaceResolver()

setNamespaceResolver

public void setNamespaceResolver(@NonNull
                                 ResourceNamespace.Resolver resolver)

Specifies logic used to resolve namespace aliases for values that come from XML files.

This method is meant to be called by the XML parser that created this ResourceValue.

setNamespaceLookup

@Deprecated
public void setNamespaceLookup(@NonNull
                                           ResourceNamespace.Resolver resolver)

Deprecated.

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