com.android.ide.common.rendering.api

Interface AttrResourceValue

All Superinterfaces:

ResourceValue, java.io.Serializable

All Known Implementing Classes:

AttrResourceValueImpl

public interface AttrResourceValue
extends ResourceValue

A resource value representing an attr resource.

The ResourceValue.getValue() method of this class always returns null. To get the numeric values associated with flags or enums use getAttributeValues().

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Integer>	getAttributeValues() Returns the enum or flag integer values keyed by the value names.
java.lang.String	getDescription() Returns the description of the attr resource obtained from an XML comment.
java.util.Set<AttributeFormat>	getFormats() Returns the formats allowed for the values of the attribute.
java.lang.String	getGroupName() Returns the name of the attr group obtained from an XML comment.
java.lang.String	getValueDescription(java.lang.String valueName) Returns the description of a enum/flag value with the given name.

Methods inherited from interface com.android.ide.common.rendering.api.ResourceValue

asReference, getLibraryName, getName, getNamespace, getNamespaceResolver, getRawXmlValue, getReference, getResourceType, getResourceUrl, getValue, isFramework, isUserDefined, setValue

Method Detail

getAttributeValues

@NonNull
java.util.Map<java.lang.String,java.lang.Integer> getAttributeValues()

Returns the enum or flag integer values keyed by the value names. Some of the values in the returned map may be null. The returned map is guaranteed to contain the names of all declared values, even the ones that don't have corresponding numeric values.

Returns:

the map of (name, integer) values

getValueDescription

@Nullable
java.lang.String getValueDescription(@NonNull
                                               java.lang.String valueName)

Returns the description of a enum/flag value with the given name.

getDescription

@Nullable
java.lang.String getDescription()

Returns the description of the attr resource obtained from an XML comment.

Returns:

the description, or null if there was no comment for this attr in XML

getGroupName

@Nullable
java.lang.String getGroupName()

Returns the name of the attr group obtained from an XML comment. For example, the following XML will produce "textAppearance" attr resource with the group name "Text styles":

   <!-- =========== -->
   <!-- Text styles -->
   <!-- =========== -->
   <eat-comment />

   <!-- Default appearance of text: color, typeface, size, and style. -->
   <attr name="textAppearance" format="reference" />
 

Attr grouping is available only for the framework resources.

Returns:

the group name, or null no grouping information is available

getFormats

@NonNull
java.util.Set<AttributeFormat> getFormats()

Returns the formats allowed for the values of the attribute.