com.android.ide.common.rendering.api

Class AttrResourceValueImpl

java.lang.Object

com.android.ide.common.rendering.api.ResourceValueImpl

com.android.ide.common.rendering.api.AttrResourceValueImpl

All Implemented Interfaces:

AttrResourceValue, ResourceValue, java.io.Serializable

public class AttrResourceValueImpl
extends ResourceValueImpl
implements AttrResourceValue

A resource value representing an attr resource.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.android.ide.common.rendering.api.ResourceValueImpl

mNamespaceResolver

Constructor Summary

Constructors

Constructor and Description
AttrResourceValueImpl(ResourceNamespace namespace, ResourceType type, java.lang.String name, java.lang.String libraryName)
AttrResourceValueImpl(ResourceReference reference, java.lang.String libraryName)

Method Summary

Modifier and Type	Method and Description
void	addValue(java.lang.String valueName, java.lang.Integer numericValue, java.lang.String description) Adds a possible value of the flag or enum attribute.
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.
void	setDescription(java.lang.String description) Sets the description of the attr resource.
void	setFormats(java.util.Collection<AttributeFormat> formats) Sets the formats allowed for the attribute.
void	setGroupName(java.lang.String groupName) Sets the name of group the attr resource belongs to.

Methods inherited from class com.android.ide.common.rendering.api.ResourceValueImpl

asReference, equals, getLibraryName, getName, getNamespace, getNamespaceResolver, getResourceType, getValue, hashCode, isFramework, isUserDefined, replaceWith, setNamespaceResolver, setValue, toString

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

AttrResourceValueImpl

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

AttrResourceValueImpl

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

Method Detail

getAttributeValues

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

Description copied from interface: AttrResourceValue

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.

Specified by:

getAttributeValues in interface AttrResourceValue

Returns:

the map of (name, integer) values, or null if no enum/flag values were defined

getValueDescription

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

Description copied from interface: AttrResourceValue

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

Specified by:

getValueDescription in interface AttrResourceValue

getDescription

@Nullable
public java.lang.String getDescription()

Description copied from interface: AttrResourceValue

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

Specified by:

getDescription in interface AttrResourceValue

Returns:

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

getGroupName

@Nullable
public java.lang.String getGroupName()

Description copied from interface: AttrResourceValue

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.

Specified by:

getGroupName in interface AttrResourceValue

Returns:

the group name, or null no grouping information is available

getFormats

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

Description copied from interface: AttrResourceValue

Returns the formats allowed for the values of the attribute.

Specified by:

getFormats in interface AttrResourceValue

addValue

public void addValue(@NonNull
                     java.lang.String valueName,
                     @Nullable
                     java.lang.Integer numericValue,
                     @Nullable
                     java.lang.String description)

Adds a possible value of the flag or enum attribute.

Parameters:

valueName - the name of the value

numericValue - the corresponding numeric value

valueName - the description of the value

setDescription

public void setDescription(@Nullable
                           java.lang.String description)

Sets the description of the attr resource.

Parameters:

description - the description to set

setGroupName

public void setGroupName(@Nullable
                         java.lang.String groupName)

Sets the name of group the attr resource belongs to.

Parameters:

groupName - the name of the group to set

setFormats

public void setFormats(@NonNull
                       java.util.Collection<AttributeFormat> formats)

Sets the formats allowed for the attribute.

Parameters:

formats - the formats to set