Added in API level 1

Summary: Methods | Inherited Methods

TypedArray

---

Kotlin |Java

public class TypedArray
extends Object implements AutoCloseable

java.lang.Object
↳	android.content.res.TypedArray

---

Container for an array of values that were retrieved with Resources.Theme.obtainStyledAttributes(AttributeSet, int[], int, int) or Resources.obtainAttributes. Be sure to call recycle() when done with them. The indices used to retrieve values from this structure correspond to the positions of the attributes given to obtainStyledAttributes.

Summary

Public methods
void	close() Recycles the TypedArray, to be re-used by a later caller.
boolean	getBoolean(int index, boolean defValue) Retrieve the boolean value for the attribute at index.
int	getChangingConfigurations() Return a mask of the configuration parameters for which the values in this typed array may change.
int	getColor(int index, int defValue) Retrieve the color value for the attribute at index.
ColorStateList	getColorStateList(int index) Retrieve the ColorStateList for the attribute at index.
float	getDimension(int index, float defValue) Retrieve a dimensional unit attribute at index.
int	getDimensionPixelOffset(int index, int defValue) Retrieve a dimensional unit attribute at index for use as an offset in raw pixels.
int	getDimensionPixelSize(int index, int defValue) Retrieve a dimensional unit attribute at index for use as a size in raw pixels.
Drawable	getDrawable(int index) Retrieve the Drawable for the attribute at index.
float	getFloat(int index, float defValue) Retrieve the float value for the attribute at index.
Typeface	getFont(int index) Retrieve the Typeface for the attribute at index.
float	getFraction(int index, int base, int pbase, float defValue) Retrieves a fractional unit attribute at index.
int	getIndex(int at) Returns an index in the array that has data.
int	getIndexCount() Returns the number of indices in the array that actually have data.
int	getInt(int index, int defValue) Retrieve the integer value for the attribute at index.
int	getInteger(int index, int defValue) Retrieve the integer value for the attribute at index.
int	getLayoutDimension(int index, int defValue) Special version of getDimensionPixelSize(int, int) for retrieving ViewGroup's layout_width and layout_height attributes.
int	getLayoutDimension(int index, String name) Special version of getDimensionPixelSize(int, int) for retrieving ViewGroup's layout_width and layout_height attributes.
String	getNonResourceString(int index) Retrieves the string value for the attribute at index, but only if that string comes from an immediate value in an XML file.
String	getPositionDescription() Returns a message about the parser state suitable for printing error messages.
int	getResourceId(int index, int defValue) Retrieves the resource identifier for the attribute at index.
Resources	getResources() Returns the Resources object this array was loaded from.
int	getSourceResourceId(int index, int defaultValue) Returns the resource ID of the style or layout against which the specified attribute was resolved, otherwise returns defValue.
String	getString(int index) Retrieves the string value for the attribute at index.
CharSequence	getText(int index) Retrieves the styled string value for the attribute at index.
CharSequence[]	getTextArray(int index) Retrieve the CharSequence[] for the attribute at index.
int	getType(int index) Returns the type of attribute at the specified index.
boolean	getValue(int index, TypedValue outValue) Retrieve the raw TypedValue for the attribute at index.
boolean	hasValue(int index) Determines whether there is an attribute at index.
boolean	hasValueOrEmpty(int index) Determines whether there is an attribute at index, returning true if the attribute was explicitly set to @empty and false only if the attribute was undefined.
int	length() Returns the number of values in this array.
TypedValue	peekValue(int index) Retrieve the raw TypedValue for the attribute at index and return a temporary object holding its data.
void	recycle() Recycles the TypedArray, to be re-used by a later caller.
String	toString() Returns a string representation of the object.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface java.lang.AutoCloseable abstract void close() Closes this resource, relinquishing any underlying resources.

Public methods

close

Added in API level 31

public void close ()

Recycles the TypedArray, to be re-used by a later caller. After calling this function you must not ever touch the typed array again.

Throws
RuntimeException	if the TypedArray has already been recycled.

See also:

• recycle()

getBoolean

Added in API level 1

public boolean getBoolean (int index, 
                boolean defValue)

Retrieve the boolean value for the attribute at index.

If the attribute is an integer value, this method returns false if the attribute is equal to zero, and true otherwise. If the attribute is not a boolean or integer value, this method will attempt to coerce it to an integer using Integer.decode(String) and return whether it is equal to zero.

Parameters
index	int: Index of attribute to retrieve.
defValue	boolean: Value to return if the attribute is not defined or cannot be coerced to an integer.

Returns
boolean	Boolean value of the attribute, or defValue if the attribute was not defined or could not be coerced to an integer.

Throws
RuntimeException	if the TypedArray has already been recycled.

getChangingConfigurations

Added in API level 21

public int getChangingConfigurations ()

Return a mask of the configuration parameters for which the values in this typed array may change.

Returns

int

Returns a mask of the changing configuration parameters, as defined by ActivityInfo. Value is either 0 or a combination of ActivityInfo.CONFIG_MCC, ActivityInfo.CONFIG_MNC, ActivityInfo.CONFIG_LOCALE, ActivityInfo.CONFIG_TOUCHSCREEN, ActivityInfo.CONFIG_KEYBOARD, ActivityInfo.CONFIG_KEYBOARD_HIDDEN, ActivityInfo.CONFIG_NAVIGATION, ActivityInfo.CONFIG_ORIENTATION, ActivityInfo.CONFIG_SCREEN_LAYOUT, ActivityInfo.CONFIG_UI_MODE, ActivityInfo.CONFIG_SCREEN_SIZE, ActivityInfo.CONFIG_SMALLEST_SCREEN_SIZE, ActivityInfo.CONFIG_DENSITY, ActivityInfo.CONFIG_LAYOUT_DIRECTION, ActivityInfo.CONFIG_COLOR_MODE, ActivityInfo.CONFIG_FONT_SCALE, ActivityInfo.CONFIG_GRAMMATICAL_GENDER, ActivityInfo.CONFIG_FONT_WEIGHT_ADJUSTMENT, android.content.pm.ActivityInfo.CONFIG_WINDOW_CONFIGURATION, ActivityInfo.CONFIG_ASSETS_PATHS, and ActivityInfo.CONFIG_RESOURCES_UNUSED

Throws
RuntimeException	if the TypedArray has already been recycled.

See also:

• ActivityInfo

getColor

Added in API level 1

public int getColor (int index, 
                int defValue)

Retrieve the color value for the attribute at index. If the attribute references a color resource holding a complex ColorStateList, then the default color from the set is returned.

This method will throw an exception if the attribute is defined but is not an integer color or color state list.

Parameters
index	int: Index of attribute to retrieve.
defValue	int: Value to return if the attribute is not defined or not a resource.

Returns
int	Attribute color value, or defValue if not defined.

Throws
RuntimeException	if the TypedArray has already been recycled.
UnsupportedOperationException	if the attribute is defined but is not an integer color or color state list.

getColorStateList

Added in API level 1

public ColorStateList getColorStateList (int index)

Retrieve the ColorStateList for the attribute at index. The value may be either a single solid color or a reference to a color or complex ColorStateList description.

This method will return null if the attribute is not defined or is not an integer color or color state list.

Parameters
index	int: Index of attribute to retrieve.

Returns
ColorStateList	ColorStateList for the attribute, or null if not defined.

Throws
RuntimeException	if the attribute if the TypedArray has already been recycled.
UnsupportedOperationException	if the attribute is defined but is not an integer color or color state list.

getDimension

Added in API level 1

public float getDimension (int index, 
                float defValue)

Retrieve a dimensional unit attribute at index. Unit conversions are based on the current DisplayMetrics associated with the resources this TypedArray object came from.

This method will throw an exception if the attribute is defined but is not a dimension.

Parameters
index	int: Index of attribute to retrieve.
defValue	float: Value to return if the attribute is not defined or not a resource.

Returns
float	Attribute dimension value multiplied by the appropriate metric, or defValue if not defined.

Throws
RuntimeException	if the TypedArray has already been recycled.
UnsupportedOperationException	if the attribute is defined but is not an integer.

See also:

• getDimensionPixelOffset(int, int)
• getDimensionPixelSize(int, int)

getDimensionPixelOffset

Added in API level 1

public int getDimensionPixelOffset (int index, 
                int defValue)

Retrieve a dimensional unit attribute at index for use as an offset in raw pixels. This is the same as getDimension(int, float), except the returned value is converted to integer pixels for you. An offset conversion involves simply truncating the base value to an integer.

This method will throw an exception if the attribute is defined but is not a dimension.

Parameters
index	int: Index of attribute to retrieve.
defValue	int: Value to return if the attribute is not defined or not a resource.

Returns
int	Attribute dimension value multiplied by the appropriate metric and truncated to integer pixels, or defValue if not defined.

Throws
RuntimeException	if the TypedArray has already been recycled.
UnsupportedOperationException	if the attribute is defined but is not an integer.

See also:

• getDimension(int, float)
• getDimensionPixelSize(int, int)

getDimensionPixelSize

Added in API level 1

public int getDimensionPixelSize (int index, 
                int defValue)

Retrieve a dimensional unit attribute at index for use as a size in raw pixels. This is the same as getDimension(int, float), except the returned value is converted to integer pixels for use as a size. A size conversion involves rounding the base value, and ensuring that a non-zero base value is at least one pixel in size.

This method will throw an exception if the attribute is defined but is not a dimension.

Parameters
index	int: Index of attribute to retrieve.
defValue	int: Value to return if the attribute is not defined or not a resource.

Returns
int	Attribute dimension value multiplied by the appropriate metric and truncated to integer pixels, or defValue if not defined.

Throws
RuntimeException	if the TypedArray has already been recycled.
UnsupportedOperationException	if the attribute is defined but is not a dimension.

See also:

• getDimension(int, float)
• getDimensionPixelOffset(int, int)

getDrawable

Added in API level 1

public Drawable getDrawable (int index)

Retrieve the Drawable for the attribute at index.

This method will throw an exception if the attribute is defined but is not a color or drawable resource.

Parameters
index	int: Index of attribute to retrieve.

Returns
Drawable	Drawable for the attribute, or null if not defined.

Throws
RuntimeException	if the TypedArray has already been recycled.
UnsupportedOperationException	if the attribute is defined but is not a color or drawable resource.

getFloat

Added in API level 1

public float getFloat (int index, 
                float defValue)

Retrieve the float value for the attribute at index.

If the attribute is not a float or an integer, this method will attempt to coerce it to a float using Float.parseFloat(String).

Parameters
index	int: Index of attribute to retrieve.
defValue	float

Returns
float	Attribute float value, or defValue if the attribute was not defined or could not be coerced to a float.

Throws
RuntimeException	if the TypedArray has already been recycled.

getFont

Added in API level 26

public Typeface getFont (int index)

Retrieve the Typeface for the attribute at index.

This method will throw an exception if the attribute is defined but is not a font.

Parameters
index	int: Index of attribute to retrieve.

Returns
Typeface	Typeface for the attribute, or null if not defined.

Throws
RuntimeException	if the TypedArray has already been recycled.
UnsupportedOperationException	if the attribute is defined but is not a font resource.

getFraction

Added in API level 1

public float getFraction (int index, 
                int base, 
                int pbase, 
                float defValue)

Retrieves a fractional unit attribute at index.

Parameters
index	int: Index of attribute to retrieve.
base	int: The base value of this fraction. In other words, a standard fraction is multiplied by this value.
pbase	int: The parent base value of this fraction. In other words, a parent fraction (nn%p) is multiplied by this value.
defValue	float: Value to return if the attribute is not defined or not a resource.

Returns
float	Attribute fractional value multiplied by the appropriate base value, or defValue if not defined.

Throws
RuntimeException	if the TypedArray has already been recycled.
UnsupportedOperationException	if the attribute is defined but is not a fraction.

getIndex

Added in API level 1

public int getIndex (int at)

Returns an index in the array that has data. Attributes with a value of @empty are included, as this is an explicit indicator.

Parameters
at	int: The index you would like to returned, ranging from 0 to getIndexCount().

Returns
int	The index at the given offset, which can be used with getValue(int, TypedValue) and related APIs.

Throws
RuntimeException	if the TypedArray has already been recycled.

getIndexCount

Added in API level 1

public int getIndexCount ()

Returns the number of indices in the array that actually have data. Attributes with a value of @empty are included, as this is an explicit indicator.

Returns
int

Throws
RuntimeException	if the TypedArray has already been recycled.

getInt

Added in API level 1

public int getInt (int index, 
                int defValue)

Retrieve the integer value for the attribute at index.

If the attribute is not an integer, this method will attempt to coerce it to an integer using Integer.decode(String).

Parameters
index	int: Index of attribute to retrieve.
defValue	int: Value to return if the attribute is not defined or cannot be coerced to an integer.

Returns
int	Integer value of the attribute, or defValue if the attribute was not defined or could not be coerced to an integer.

Throws
RuntimeException	if the TypedArray has already been recycled.

getInteger

Added in API level 1

public int getInteger (int index, 
                int defValue)

Retrieve the integer value for the attribute at index.

Unlike getInt(int, int), this method will throw an exception if the attribute is defined but is not an integer.

Parameters
index	int: Index of attribute to retrieve.
defValue	int: Value to return if the attribute is not defined or not a resource.

Returns
int	Attribute integer value, or defValue if not defined.

Throws
RuntimeException	if the TypedArray has already been recycled.
UnsupportedOperationException	if the attribute is defined but is not an integer.

getLayoutDimension

Added in API level 3

public int getLayoutDimension (int index, 
                int defValue)

Special version of getDimensionPixelSize(int, int) for retrieving ViewGroup's layout_width and layout_height attributes. This is only here for performance reasons; applications should use getDimensionPixelSize(int, int).

Parameters
index	int: Index of the attribute to retrieve.
defValue	int: The default value to return if this attribute is not default or contains the wrong type of data.

Returns
int	Attribute dimension value multiplied by the appropriate metric and truncated to integer pixels.

Throws
RuntimeException	if the TypedArray has already been recycled.

getLayoutDimension

Added in API level 1

public int getLayoutDimension (int index, 
                String name)

Special version of getDimensionPixelSize(int, int) for retrieving ViewGroup's layout_width and layout_height attributes. This is only here for performance reasons; applications should use getDimensionPixelSize(int, int).

This method will throw an exception if the attribute is defined but is not a dimension or integer (enum).

Parameters
index	int: Index of the attribute to retrieve.
name	String: Textual name of attribute for error reporting.

Returns
int	Attribute dimension value multiplied by the appropriate metric and truncated to integer pixels.

Throws
RuntimeException	if the TypedArray has already been recycled.
UnsupportedOperationException	if the attribute is defined but is not a dimension or integer (enum).

getNonResourceString

Added in API level 1

public String getNonResourceString (int index)

Retrieves the string value for the attribute at index, but only if that string comes from an immediate value in an XML file. That is, this does not allow references to string resources, string attributes, or conversions from other types. As such, this method will only return strings for TypedArray objects that come from attributes in an XML file.

Parameters
index	int: Index of attribute to retrieve.

Returns
String	String holding string data. Any styling information is removed. Returns null if the attribute is not defined or is not an immediate string value.

Throws
RuntimeException	if the TypedArray has already been recycled.

getPositionDescription

Added in API level 1

public String getPositionDescription ()

Returns a message about the parser state suitable for printing error messages.

Returns
String	Human-readable description of current parser state.

Throws
RuntimeException	if the TypedArray has already been recycled.

getResourceId

Added in API level 1

public int getResourceId (int index, 
                int defValue)

Retrieves the resource identifier for the attribute at index. Note that attribute resource as resolved when the overall TypedArray object is retrieved. As a result, this function will return the resource identifier of the final resource value that was found, not necessarily the original resource that was specified by the attribute.

Parameters
index	int: Index of attribute to retrieve.
defValue	int: Value to return if the attribute is not defined or not a resource.

Returns
int	Attribute resource identifier, or defValue if not defined.

Throws
RuntimeException	if the TypedArray has already been recycled.

getResources

Added in API level 1

public Resources getResources ()

Returns the Resources object this array was loaded from.

Returns
Resources

Throws
RuntimeException	if the TypedArray has already been recycled.

getSourceResourceId

Added in API level 29

public int getSourceResourceId (int index, 
                int defaultValue)

Returns the resource ID of the style or layout against which the specified attribute was resolved, otherwise returns defValue. For example, if you we resolving two attributes android:attribute1 and android:attribute2 and you were inflating a View from layout/my_layout.xml:

     <View
         style="@style/viewStyle"
         android:layout_width="wrap_content"
         android:layout_height="wrap_content"
         android:attribute1="foo"/>
 

and @style/viewStyle is:

     <style android:name="viewStyle">
         <item name="android:attribute2">bar<item/>
     <style/>
 

then resolved TypedArray will have values that return source resource ID of R.layout.my_layout for android:attribute1 and R.style.viewStyle for android:attribute2.

Parameters
index	int: Index of attribute whose source style to retrieve.
defaultValue	int: Value to return if the attribute is not defined or not a resource.

Returns
int	Either a style resource ID, layout resource ID, or defaultValue if it was not resolved in a style or layout.

Throws
RuntimeException	if the TypedArray has already been recycled.

getString

Added in API level 1

public String getString (int index)

Retrieves the string value for the attribute at index.

If the attribute is not a string, this method will attempt to coerce it to a string.

Parameters
index	int: Index of attribute to retrieve.

Returns
String	String holding string data. Any styling information is removed. Returns null if the attribute is not defined or could not be coerced to a string.

Throws
RuntimeException	if the TypedArray has already been recycled.

getText

Added in API level 1

public CharSequence getText (int index)

Retrieves the styled string value for the attribute at index.

If the attribute is not a string, this method will attempt to coerce it to a string.

Parameters
index	int: Index of attribute to retrieve.

Returns
CharSequence	CharSequence holding string data. May be styled. Returns null if the attribute is not defined or could not be coerced to a string.

Throws
RuntimeException	if the TypedArray has already been recycled.

getTextArray

Added in API level 1

public CharSequence[] getTextArray (int index)

Retrieve the CharSequence[] for the attribute at index. This gets the resource ID of the selected attribute, and uses Resources.getTextArray of the owning Resources object to retrieve its String[].

This method will throw an exception if the attribute is defined but is not a text array resource.

Parameters
index	int: Index of attribute to retrieve.

Returns
CharSequence[]	CharSequence[] for the attribute, or null if not defined.

Throws
RuntimeException	if the TypedArray has already been recycled.

getType

Added in API level 21

public int getType (int index)

Returns the type of attribute at the specified index.

Parameters
index	int: Index of attribute whose type to retrieve.

Returns
int	Attribute type.

Throws
RuntimeException	if the TypedArray has already been recycled.

getValue

Added in API level 1

public boolean getValue (int index, 
                TypedValue outValue)

Retrieve the raw TypedValue for the attribute at index.

Parameters
index	int: Index of attribute to retrieve.
outValue	TypedValue: TypedValue object in which to place the attribute's data.

Returns
boolean	true if the value was retrieved and not @empty, false otherwise.

Throws
RuntimeException	if the TypedArray has already been recycled.

hasValue

Added in API level 1

public boolean hasValue (int index)

Determines whether there is an attribute at index.

Note: If the attribute was set to @empty or @undefined, this method returns false.

Parameters
index	int: Index of attribute to retrieve.

Returns
boolean	True if the attribute has a value, false otherwise.

Throws
RuntimeException	if the TypedArray has already been recycled.

hasValueOrEmpty

Added in API level 22

public boolean hasValueOrEmpty (int index)

Determines whether there is an attribute at index, returning true if the attribute was explicitly set to @empty and false only if the attribute was undefined.

Parameters
index	int: Index of attribute to retrieve.

Returns
boolean	True if the attribute has a value or is empty, false otherwise.

Throws
RuntimeException	if the TypedArray has already been recycled.

length

Added in API level 1

public int length ()

Returns the number of values in this array.

Returns
int

Throws
RuntimeException	if the TypedArray has already been recycled.

peekValue

Added in API level 1

public TypedValue peekValue (int index)

Retrieve the raw TypedValue for the attribute at index and return a temporary object holding its data. This object is only valid until the next call on to TypedArray.

Parameters
index	int: Index of attribute to retrieve.

Returns
TypedValue	Returns a TypedValue object if the attribute is defined, containing its data; otherwise returns null. (You will not receive a TypedValue whose type is TYPE_NULL.)

Throws
RuntimeException	if the TypedArray has already been recycled.

recycle

Added in API level 1

public void recycle ()

Recycles the TypedArray, to be re-used by a later caller. After calling this function you must not ever touch the typed array again.

Throws
RuntimeException	if the TypedArray has already been recycled.

toString

Added in API level 1

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.