Added in API level 1
Deprecated in API level 24

MockResources


open class MockResources : Resources
kotlin.Any
   ↳ android.content.res.Resources
   ↳ android.test.mock.MockResources

A mock android.content.res.Resources class. All methods are non-functional and throw java.lang.UnsupportedOperationException. Override it to provide the operations that you need.

Summary

Inherited constants
Public constructors

Public methods
open XmlResourceParser

Return an XmlResourceParser through which you can read an animation description for the given resource ID.

open Int

Returns a color integer associated with a particular resource ID.

open ColorStateList

Returns a color state list associated with a particular resource ID.

open Configuration!

Return the current configuration that is in effect for this resource object.

open Float

Retrieve a dimensional for a particular resource ID.

open Int

Retrieve a dimensional for a particular resource ID for use as an offset in raw pixels.

open Int

Retrieve a dimensional for a particular resource ID for use as a size in raw pixels.

open DisplayMetrics!

Returns the current display metrics that are in effect for this resource object.

open Drawable!

Return a drawable object associated with a particular resource ID.

open Int
getIdentifier(name: String!, defType: String!, defPackage: String!)

Return a resource identifier for the given resource name.

open IntArray

Return the int array associated with a particular resource ID.

open Int

Return an integer associated with a particular resource ID.

open XmlResourceParser

Return an XmlResourceParser through which you can read a view layout description for the given resource ID.

open Movie!

Return a movie object associated with the particular resource ID.

open String
getQuantityString(id: Int, quantity: Int)

Returns the string necessary for grammatically correct pluralization of the given resource ID for the given quantity.

open String
getQuantityString(id: Int, quantity: Int, vararg formatArgs: Any!)

Formats the string necessary for grammatically correct pluralization of the given resource ID for the given quantity, using the given arguments.

open CharSequence
getQuantityText(id: Int, quantity: Int)

Returns the character sequence necessary for grammatically correct pluralization of the given resource ID for the given quantity.

open String!

Return the entry name for a given resource identifier.

open String!

Return the full name for a given resource identifier.

open String!

Return the package name for a given resource identifier.

open String!

Return the type name for a given resource identifier.

open String

Return the string value associated with a particular resource ID.

open String
getString(id: Int, vararg formatArgs: Any!)

Return the string value associated with a particular resource ID, substituting the format arguments as defined in java.util.Formatter and java.

open Array<String!>

Return the string array associated with a particular resource ID.

open CharSequence
getText(id: Int)

Return the string value associated with a particular resource ID.

open CharSequence!
getText(id: Int, def: CharSequence!)

Return the string value associated with a particular resource ID.

open Array<CharSequence!>

Return the styled text array associated with a particular resource ID.

open Unit
getValue(id: Int, outValue: TypedValue!, resolveRefs: Boolean)

Return the raw data associated with a particular resource ID.

open Unit
getValue(name: String!, outValue: TypedValue!, resolveRefs: Boolean)

Return the raw data associated with a particular resource ID.

open XmlResourceParser
getXml(id: Int)

Return an XmlResourceParser through which you can read a generic XML resource for the given resource ID.

open TypedArray!

Retrieve a set of basic attribute values from an AttributeSet, not performing styling of them using a theme and/or style resources.

open TypedArray

Return an array of heterogeneous values.

open InputStream

Open a data stream for reading a raw resource.

open AssetFileDescriptor!

Open a file descriptor for reading a raw resource.

open Unit

Store the newly updated configuration.

Inherited functions

Public constructors

MockResources

Added in API level 1
MockResources()

Public methods

getAnimation

Added in API level 1
open fun getAnimation(id: Int): XmlResourceParser

Deprecated: Deprecated in Java.

Return an XmlResourceParser through which you can read an animation description for the given resource ID. This parser has limited functionality -- in particular, you can't change its input, and only the high-level events are available.

This function is really a simple wrapper for calling getXml with an animation resource.

Parameters
id Int: The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
Return
XmlResourceParser A new parser object through which you can read the XML data.
This value cannot be null.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

getColor

Added in API level 1
open fun getColor(id: Int): Int

Deprecated: Deprecated in Java.

Returns a color integer associated with a particular resource ID. If the resource holds a complex ColorStateList, then the default color from the set is returned.

Parameters
id Int: The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
Return
Int A single color value in the form 0xAARRGGBB.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

getColorStateList

Added in API level 1
open fun getColorStateList(id: Int): ColorStateList

Deprecated: Deprecated in Java.

Returns a color state list associated with a particular resource ID. The resource may contain either a single raw color value or a complex ColorStateList holding multiple possible colors.

Parameters
id Int: The desired resource identifier of a ColorStateList, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
Return
ColorStateList A ColorStateList object containing either a single solid color or multiple colors that can be selected based on a state.
This value cannot be null.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

getConfiguration

Added in API level 1
open fun getConfiguration(): Configuration!

Deprecated: Deprecated in Java.

Return the current configuration that is in effect for this resource object. The returned object should be treated as read-only.

Return
Configuration! The resource's current configuration.

getDimension

Added in API level 1
open fun getDimension(id: Int): Float

Deprecated: Deprecated in Java.

Retrieve a dimensional for a particular resource ID. Unit conversions are based on the current DisplayMetrics associated with the resources.

Parameters
id Int: The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
Return
Float Resource dimension value multiplied by the appropriate metric to convert to pixels.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

getDimensionPixelOffset

Added in API level 1
open fun getDimensionPixelOffset(id: Int): Int

Deprecated: Deprecated in Java.

Retrieve a dimensional for a particular resource ID for use as an offset in raw pixels. This is the same as getDimension, except the returned value is converted to integer pixels for you. An offset conversion involves simply truncating the base value to an integer.

Parameters
id Int: The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
Return
Int Resource dimension value multiplied by the appropriate metric and truncated to integer pixels.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

getDimensionPixelSize

Added in API level 1
open fun getDimensionPixelSize(id: Int): Int

Deprecated: Deprecated in Java.

Retrieve a dimensional for a particular resource ID for use as a size in raw pixels. This is the same as getDimension, 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.

Parameters
id Int: The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
Return
Int Resource dimension value multiplied by the appropriate metric and truncated to integer pixels.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

getDisplayMetrics

Added in API level 1
open fun getDisplayMetrics(): DisplayMetrics!

Deprecated: Deprecated in Java.

Returns the current display metrics that are in effect for this resource object. The returned object should be treated as read-only.

Note that the reported value may be different than the window this application is interested in.

The best practices is to obtain metrics from WindowManager.getCurrentWindowMetrics() for window bounds. The value obtained from this API may be wrong if Context.getResources() is not from a UiContext. For example, use the DisplayMetrics obtained from Application.getResources() to build android.app.Activity UI elements especially when the android.app.Activity is in the multi-window mode or on the secondary Display.

Return
DisplayMetrics! The resource's current display metrics.

getDrawable

Added in API level 1
open fun getDrawable(id: Int): Drawable!

Deprecated: Deprecated in Java.

Return a drawable object associated with a particular resource ID. Various types of objects will be returned depending on the underlying resource -- for example, a solid color, PNG image, scalable image, etc. The Drawable API hides these implementation details.

Note: Prior to android.os.Build.VERSION_CODES#JELLY_BEAN, this function would not correctly retrieve the final configuration density when the resource ID passed here is an alias to another Drawable resource. This means that if the density configuration of the alias resource is different than the actual resource, the density of the returned Drawable would be incorrect, resulting in bad scaling. To work around this, you can instead manually resolve the aliased reference by using getValue(int,android.util.TypedValue,boolean) and passing true for resolveRefs. The resulting TypedValue.resourceId value may be passed to this method.

Note: To obtain a themed drawable, use Context.getDrawable(int) or getDrawable(int,android.content.res.Resources.Theme) passing the desired theme.

Parameters
id Int: The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
Return
Drawable! Drawable An object that can be used to draw this resource.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

getIdentifier

Added in API level 1
open fun getIdentifier(
    name: String!,
    defType: String!,
    defPackage: String!
): Int

Deprecated: Deprecated in Java.

Return a resource identifier for the given resource name. A fully qualified resource name is of the form "package:type/entry". The first two components (package and type) are optional if defType and defPackage, respectively, are specified here.

Note: use of this function is discouraged. It is much more efficient to retrieve resources by identifier than by name.

Parameters
name String!: The name of the desired resource.
defType String!: Optional default resource type to find, if "type/" is not included in the name. Can be null to require an explicit type.
defPackage String!: Optional default package to find, if "package:" is not included in the name. Can be null to require an explicit package.
Return
Int int The associated resource identifier. Returns 0 if no such resource was found. (0 is not a valid resource ID.)

getIntArray

Added in API level 1
open fun getIntArray(id: Int): IntArray

Deprecated: Deprecated in Java.

Return the int array associated with a particular resource ID.

Parameters
id Int: The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
Return
IntArray The int array associated with the resource.
This value cannot be null.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

getInteger

Added in API level 1
open fun getInteger(id: Int): Int

Deprecated: Deprecated in Java.

Return an integer associated with a particular resource ID.

Parameters
id Int: The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
Return
Int Returns the integer value contained in the resource.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

getLayout

Added in API level 1
open fun getLayout(id: Int): XmlResourceParser

Deprecated: Deprecated in Java.

Return an XmlResourceParser through which you can read a view layout description for the given resource ID. This parser has limited functionality -- in particular, you can't change its input, and only the high-level events are available.

This function is really a simple wrapper for calling getXml with a layout resource.

Parameters
id Int: The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
Return
XmlResourceParser A new parser object through which you can read the XML data.
This value cannot be null.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

getMovie

Added in API level 1
open fun getMovie(id: Int): Movie!

Deprecated: Deprecated in Java.

Return a movie object associated with the particular resource ID.

Parameters
id Int: The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

getQuantityString

Added in API level 1
open fun getQuantityString(
    id: Int,
    quantity: Int
): String

Deprecated: Deprecated in Java.

Returns the string necessary for grammatically correct pluralization of the given resource ID for the given quantity. Note that the string is selected based solely on grammatical necessity, and that such rules differ between languages. Do not assume you know which string will be returned for a given quantity. See String Resources for more detail.

Parameters
id Int: The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
quantity Int: The number used to get the correct string for the current language's plural rules.
Return
String String The string data associated with the resource, stripped of styled text information.
This value cannot be null.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

getQuantityString

Added in API level 1
open fun getQuantityString(
    id: Int,
    quantity: Int,
    vararg formatArgs: Any!
): String

Deprecated: Deprecated in Java.

Formats the string necessary for grammatically correct pluralization of the given resource ID for the given quantity, using the given arguments. Note that the string is selected based solely on grammatical necessity, and that such rules differ between languages. Do not assume you know which string will be returned for a given quantity. See String Resources for more detail.

Substitution of format arguments works as if using java.util.Formatter and java.lang.String#format. The resulting string will be stripped of any styled text information.

Parameters
id Int: The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
quantity Int: The number used to get the correct string for the current language's plural rules.
formatArgs Any!: The format arguments that will be used for substitution.
Return
String String The string data associated with the resource, stripped of styled text information.
This value cannot be null.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

getQuantityText

Added in API level 1
open fun getQuantityText(
    id: Int,
    quantity: Int
): CharSequence

Deprecated: Deprecated in Java.

Returns the character sequence necessary for grammatically correct pluralization of the given resource ID for the given quantity. Note that the character sequence is selected based solely on grammatical necessity, and that such rules differ between languages. Do not assume you know which string will be returned for a given quantity. See String Resources for more detail.

Parameters
id Int: The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
quantity Int: The number used to get the correct string for the current language's plural rules.
Return
CharSequence CharSequence The string data associated with the resource, plus possibly styled text information.
This value cannot be null.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

getResourceEntryName

Added in API level 1
open fun getResourceEntryName(resid: Int): String!

Deprecated: Deprecated in Java.

Return the entry name for a given resource identifier.

Parameters
resid Int: The resource identifier whose entry name is to be retrieved.
Return
String! A string holding the entry name of the resource.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

getResourceName

Added in API level 1
open fun getResourceName(resid: Int): String!

Deprecated: Deprecated in Java.

Return the full name for a given resource identifier. This name is a single string of the form "package:type/entry".

Parameters
resid Int: The resource identifier whose name is to be retrieved.
Return
String! A string holding the name of the resource.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

getResourcePackageName

Added in API level 1
open fun getResourcePackageName(resid: Int): String!

Deprecated: Deprecated in Java.

Return the package name for a given resource identifier.

Parameters
resid Int: The resource identifier whose package name is to be retrieved.
Return
String! A string holding the package name of the resource.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

getResourceTypeName

Added in API level 1
open fun getResourceTypeName(resid: Int): String!

Deprecated: Deprecated in Java.

Return the type name for a given resource identifier.

Parameters
resid Int: The resource identifier whose type name is to be retrieved.
Return
String! A string holding the type name of the resource.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

getString

Added in API level 1
open fun getString(id: Int): String

Deprecated: Deprecated in Java.

Return the string value associated with a particular resource ID. It will be stripped of any styled text information. {@more}

Parameters
id Int: The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
Return
String String The string data associated with the resource, stripped of styled text information.
This value cannot be null.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

getString

Added in API level 1
open fun getString(
    id: Int,
    vararg formatArgs: Any!
): String

Deprecated: Deprecated in Java.

Return the string value associated with a particular resource ID, substituting the format arguments as defined in java.util.Formatter and java.lang.String#format. It will be stripped of any styled text information. {@more}

Parameters
id Int: The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
formatArgs Any!: The format arguments that will be used for substitution.
Return
String String The string data associated with the resource, stripped of styled text information.
This value cannot be null.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

getStringArray

Added in API level 1
open fun getStringArray(id: Int): Array<String!>

Deprecated: Deprecated in Java.

Return the string array associated with a particular resource ID.

Parameters
id Int: The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
Return
Array<String!> The string array associated with the resource.
This value cannot be null.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

getText

Added in API level 1
open fun getText(id: Int): CharSequence

Deprecated: Deprecated in Java.

Return the string value associated with a particular resource ID. The returned object will be a String if this is a plain string; it will be some other type of CharSequence if it is styled. {@more}

Parameters
id Int: The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
Return
CharSequence CharSequence The string data associated with the resource, plus possibly styled text information.
This value cannot be null.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

getText

Added in API level 1
open fun getText(
    id: Int,
    def: CharSequence!
): CharSequence!

Deprecated: Deprecated in Java.

Return the string value associated with a particular resource ID. The returned object will be a String if this is a plain string; it will be some other type of CharSequence if it is styled.

Parameters
id Int: The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
def CharSequence!: The default CharSequence to return.
Return
CharSequence! CharSequence The string data associated with the resource, plus possibly styled text information, or def if id is 0 or not found.

getTextArray

Added in API level 1
open fun getTextArray(id: Int): Array<CharSequence!>

Deprecated: Deprecated in Java.

Return the styled text array associated with a particular resource ID.

Parameters
id Int: The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
Return
Array<CharSequence!> The styled text array associated with the resource.
This value cannot be null.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

getValue

Added in API level 1
open fun getValue(
    id: Int,
    outValue: TypedValue!,
    resolveRefs: Boolean
): Unit

Deprecated: Deprecated in Java.

Return the raw data associated with a particular resource ID.

Parameters
id Int: The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
outValue TypedValue!: Object in which to place the resource data.
resolveRefs Boolean: If true, a resource that is a reference to another resource will be followed so that you receive the actual final resource data. If false, the TypedValue will be filled in with the reference itself.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

getValue

Added in API level 1
open fun getValue(
    name: String!,
    outValue: TypedValue!,
    resolveRefs: Boolean
): Unit

Deprecated: Deprecated in Java.

Return the raw data associated with a particular resource ID. See getIdentifier() for information on how names are mapped to resource IDs, and getString(int) for information on how string resources are retrieved.

Note: use of this function is discouraged. It is much more efficient to retrieve resources by identifier than by name.

Parameters
name String!: The name of the desired resource. This is passed to getIdentifier() with a default type of "string".
outValue TypedValue!: Object in which to place the resource data.
resolveRefs Boolean: If true, a resource that is a reference to another resource will be followed so that you receive the actual final resource data. If false, the TypedValue will be filled in with the reference itself.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

getXml

Added in API level 1
open fun getXml(id: Int): XmlResourceParser

Deprecated: Deprecated in Java.

Return an XmlResourceParser through which you can read a generic XML resource for the given resource ID.

The XmlPullParser implementation returned here has some limited functionality. In particular, you can't change its input, and only high-level parsing events are available (since the document was pre-parsed for you at build time, which involved merging text and stripping comments).

Parameters
id Int: The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
Return
XmlResourceParser A new parser object through which you can read the XML data.
This value cannot be null.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

obtainAttributes

Added in API level 1
open fun obtainAttributes(
    set: AttributeSet!,
    attrs: IntArray!
): TypedArray!

Deprecated: Deprecated in Java.

Retrieve a set of basic attribute values from an AttributeSet, not performing styling of them using a theme and/or style resources.

Parameters
set AttributeSet!: The current attribute values to retrieve.
attrs IntArray!: The specific attributes to be retrieved. These attribute IDs must be sorted in ascending order.
Return
TypedArray! Returns a TypedArray holding an array of the attribute values. Be sure to call TypedArray.recycle() when done with it.

obtainTypedArray

Added in API level 1
open fun obtainTypedArray(id: Int): TypedArray

Deprecated: Deprecated in Java.

Return an array of heterogeneous values.

Parameters
id Int: The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
Return
TypedArray Returns a TypedArray holding an array of the array values. Be sure to call TypedArray.recycle() when done with it.
This value cannot be null.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

openRawResource

Added in API level 1
open fun openRawResource(id: Int): InputStream

Deprecated: Deprecated in Java.

Open a data stream for reading a raw resource. This can only be used with resources whose value is the name of an asset files -- that is, it can be used to open drawable, sound, and raw resources; it will fail on string and color resources.

Parameters
id Int: The resource identifier to open, as generated by the aapt tool.
Return
InputStream InputStream Access to the resource data.
This value cannot be null.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

openRawResourceFd

Added in API level 1
open fun openRawResourceFd(id: Int): AssetFileDescriptor!

Deprecated: Deprecated in Java.

Open a file descriptor for reading a raw resource. This can only be used with resources whose value is the name of an asset files -- that is, it can be used to open drawable, sound, and raw resources; it will fail on string and color resources.

This function only works for resources that are stored in the package as uncompressed data, which typically includes things like mp3 files and png images.

Parameters
id Int: The resource identifier to open, as generated by the aapt tool.
Return
AssetFileDescriptor! AssetFileDescriptor A new file descriptor you can use to read the resource. This includes the file descriptor itself, as well as the offset and length of data where the resource appears in the file. A null is returned if the file exists but is compressed.
Exceptions
android.content.res.Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

updateConfiguration

Added in API level 1
open fun updateConfiguration(
    config: Configuration!,
    metrics: DisplayMetrics!
): Unit

Deprecated: Deprecated in Java.

Store the newly updated configuration.