com.android.resources

Enum ResourceType

java.lang.Object

java.lang.Enum<ResourceType>

com.android.resources.ResourceType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ResourceType>

public enum ResourceType
extends java.lang.Enum<ResourceType>

Enum representing a type of compiled resource.

See ResourceType in aapt2/Resource.h.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AAPT This type is used for elements dynamically generated by the parsing of aapt:attr nodes.
ANIM
ANIMATOR
ARRAY
ATTR
BOOL
COLOR
DIMEN
DRAWABLE
FONT
FRACTION
ID
INTEGER
INTERPOLATOR
LAYOUT
MENU
MIPMAP
NAVIGATION
PLURALS
PUBLIC This is not actually used.
RAW
SAMPLE_DATA Not an actual resource type from AAPT.
STRING
STYLE
STYLE_ITEM Represents item tags inside a style definition.
STYLEABLE
TRANSITION
XML

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.collect.ImmutableSet<ResourceType>	REFERENCEABLE_TYPES The set of all types of resources that can be referenced by other resources.

Method Summary

Modifier and Type	Method and Description
static ResourceType	fromClassName(java.lang.String className) Returns the enum by its name as it appears in the R class.
static ResourceType	fromFolderName(java.lang.String folderName) Returns the enum by its name as it appears as a folder name under res/.
static ResourceType	fromXmlTag(org.w3c.dom.Node domNode)
static <T> ResourceType	fromXmlTag(T tag, java.util.function.Function<T,java.lang.String> nameFunction, java.util.function.BiFunction<T,java.lang.String,java.lang.String> attributeFunction)
static ResourceType	fromXmlTagName(java.lang.String tagName) Returns the enum by its name as it appears in XML as a tag name.
static ResourceType	fromXmlValue(java.lang.String xmlValue) Returns the enum by its name as it appears in a ResourceUrl string.
boolean	getCanBeReferenced() Returns true if this ResourceType can be referenced using the ResourceUrl syntax: @typeName/resourceName.
java.lang.String	getDisplayName() Returns a translated display name for the resource type.
static ResourceType	getEnum(java.lang.String className) Deprecated. Use other static methods in this class. Kept for layoutlib binary compatibility.
boolean	getHasInnerClass() Returns true if the generated R class contains an inner class for this ResourceType.
java.lang.String	getName() Returns the resource type name, as used by XML files.
java.lang.String	toString()
static ResourceType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ResourceType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ANIM

public static final ResourceType ANIM

ANIMATOR

public static final ResourceType ANIMATOR

ARRAY

public static final ResourceType ARRAY

ATTR

public static final ResourceType ATTR

BOOL

public static final ResourceType BOOL

COLOR

public static final ResourceType COLOR

DIMEN

public static final ResourceType DIMEN

DRAWABLE

public static final ResourceType DRAWABLE

FONT

public static final ResourceType FONT

FRACTION

public static final ResourceType FRACTION

ID

public static final ResourceType ID

INTEGER

public static final ResourceType INTEGER

INTERPOLATOR

public static final ResourceType INTERPOLATOR

LAYOUT

public static final ResourceType LAYOUT

MENU

public static final ResourceType MENU

MIPMAP

public static final ResourceType MIPMAP

NAVIGATION

public static final ResourceType NAVIGATION

PLURALS

public static final ResourceType PLURALS

RAW

public static final ResourceType RAW

STRING

public static final ResourceType STRING

STYLE

public static final ResourceType STYLE

STYLEABLE

public static final ResourceType STYLEABLE

TRANSITION

public static final ResourceType TRANSITION

XML

public static final ResourceType XML

PUBLIC

public static final ResourceType PUBLIC

This is not actually used. Only there because they get parsed and since we want to detect new resource type, we need to have this one exist.

AAPT

public static final ResourceType AAPT

This type is used for elements dynamically generated by the parsing of aapt:attr nodes. The "aapt:attr" allow to inline resources as part of a different resource, for example, a drawable as part of a layout. When the parser, encounters one of this nodes, it will generate a synthetic _aaptattr reference.

STYLE_ITEM

public static final ResourceType STYLE_ITEM

Represents item tags inside a style definition.

SAMPLE_DATA

public static final ResourceType SAMPLE_DATA

Not an actual resource type from AAPT. Used to provide sample data values in the tools namespace

Field Detail

REFERENCEABLE_TYPES

public static final com.google.common.collect.ImmutableSet<ResourceType> REFERENCEABLE_TYPES

The set of all types of resources that can be referenced by other resources.

Method Detail

values

public static ResourceType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ResourceType c : ResourceType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ResourceType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getName

@NonNull
public java.lang.String getName()

Returns the resource type name, as used by XML files.

getDisplayName

@NonNull
public java.lang.String getDisplayName()

Returns a translated display name for the resource type.

fromClassName

@Nullable
public static ResourceType fromClassName(@NonNull
                                                   java.lang.String className)

Returns the enum by its name as it appears in the R class.

Parameters:

className - name of the inner class of the R class, e.g. "string" or "styleable".

fromFolderName

@Nullable
public static ResourceType fromFolderName(@NonNull
                                                    java.lang.String folderName)

Returns the enum by its name as it appears as a folder name under res/.

Parameters:

folderName - name of the inner class of the R class, e.g. "drawable" or "color".

fromXmlTagName

@Nullable
public static ResourceType fromXmlTagName(@NonNull
                                                    java.lang.String tagName)

Returns the enum by its name as it appears in XML as a tag name.

Parameters:

tagName - name of the XML tag, e.g. "string" or "declare-styleable".

fromXmlValue

@Nullable
public static ResourceType fromXmlValue(@NonNull
                                                  java.lang.String xmlValue)

Returns the enum by its name as it appears in a ResourceUrl string.

Parameters:

xmlValue - value of the type attribute or the prefix of a ResourceUrl, e.g. "string" or "array".

fromXmlTag

@Nullable
public static <T> ResourceType fromXmlTag(@NonNull
                                                    T tag,
                                                    @NonNull
                                                    java.util.function.Function<T,java.lang.String> nameFunction,
                                                    @NonNull
                                                    java.util.function.BiFunction<T,java.lang.String,java.lang.String> attributeFunction)

fromXmlTag

@Nullable
public static ResourceType fromXmlTag(@NonNull
                                                org.w3c.dom.Node domNode)

getEnum

@Deprecated
public static ResourceType getEnum(@NonNull
                                               java.lang.String className)

Deprecated. Use other static methods in this class. Kept for layoutlib binary compatibility.

getHasInnerClass

public boolean getHasInnerClass()

Returns true if the generated R class contains an inner class for this ResourceType.

getCanBeReferenced

public boolean getCanBeReferenced()

Returns true if this ResourceType can be referenced using the ResourceUrl syntax: @typeName/resourceName.

toString

@NonNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<ResourceType>