com.android.ide.common.rendering.api

Interface ResourceValue

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ArrayResourceValue, AttrResourceValue, DensityBasedResourceValue, PluralsResourceValue, SampleDataResourceValue, StyleableResourceValue, StyleItemResourceValue, StyleResourceValue, TextResourceValue

All Known Implementing Classes:

ArrayResourceValueImpl, AttrResourceValueImpl, DensityBasedResourceValueImpl, PluralsResourceValueImpl, ResourceValueImpl, SampleDataResourceValueImpl, StyleableResourceValueImpl, StyleItemResourceValueImpl, StyleResourceValueImpl, TextResourceValueImpl

public interface ResourceValue
extends java.io.Serializable

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

Method Summary

Modifier and Type	Method and Description
ResourceReference	asReference()
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()
default java.lang.String	getRawXmlValue() Similar to getValue(), but returns the raw XML value.
default ResourceReference	getReference() If this ResourceValue references another one, returns a ResourceReference to it, otherwise null.
ResourceType	getResourceType()
default ResourceUrl	getResourceUrl()
java.lang.String	getValue() Returns the value of the resource, as defined in the XML.
boolean	isFramework()
boolean	isUserDefined() Returns true if the resource is user defined.
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.

Method Detail

getResourceType

@NonNull
ResourceType getResourceType()

getNamespace

@NonNull
ResourceNamespace getNamespace()

getName

@NonNull
java.lang.String getName()

getLibraryName

@Nullable
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

boolean isUserDefined()

Returns true if the resource is user defined.

isFramework

boolean isFramework()

getValue

@Nullable
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
ResourceReference asReference()

getResourceUrl

@NonNull
default ResourceUrl getResourceUrl()

getReference

@Nullable
default 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

@Nullable
default 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

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

Sets the value of the resource.

Parameters:

value - the new value

getNamespaceResolver

@NonNull
ResourceNamespace.Resolver getNamespaceResolver()

setNamespaceResolver

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.