android.test.mock
Class MockResources

java.lang.Object
  android.content.res.Resources
      android.test.mock.MockResources

public class MockResources
extends Resources

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

Nested Class Summary

Nested classes/interfaces inherited from class android.content.res.Resources

Resources.NotFoundException, Resources.Theme

Constructor Summary

MockResources()

Method Summary

XmlResourceParser	getAnimation(int id) Return an XmlResourceParser through which you can read an animation description for the given resource ID.
int	getColor(int id) Return a color integer associated with a particular resource ID.
ColorStateList	getColorStateList(int id) Return a color state list associated with a particular resource ID.
Configuration	getConfiguration() Return the current configuration that is in effect for this resource object.
float	getDimension(int id) Retrieve a dimensional for a particular resource ID.
int	getDimensionPixelOffset(int id) Retrieve a dimensional for a particular resource ID for use as an offset in raw pixels.
int	getDimensionPixelSize(int id) Retrieve a dimensional for a particular resource ID for use as a size in raw pixels.
DisplayMetrics	getDisplayMetrics() Return the current display metrics that are in effect for this resource object.
Drawable	getDrawable(int id) Return a drawable object associated with a particular resource ID.
int	getIdentifier(String name, String defType, String defPackage) Return a resource identifier for the given resource name.
int[]	getIntArray(int id) Return the int array associated with a particular resource ID.
int	getInteger(int id) Return an integer associated with a particular resource ID.
XmlResourceParser	getLayout(int id) Return an XmlResourceParser through which you can read a view layout description for the given resource ID.
Movie	getMovie(int id) Return a movie object associated with the particular resource ID.
String	getQuantityString(int id, int quantity) Return the string value associated with a particular resource ID for a particular numerical quantity.
String	getQuantityString(int id, int quantity, Object... formatArgs) Return the string value associated with a particular resource ID for a particular numerical quantity, substituting the format arguments as defined in Formatter and String.format(java.lang.String, java.lang.Object...).
CharSequence	getQuantityText(int id, int quantity)
String	getResourceEntryName(int resid) Return the entry name for a given resource identifier.
String	getResourceName(int resid) Return the full name for a given resource identifier.
String	getResourcePackageName(int resid) Return the package name for a given resource identifier.
String	getResourceTypeName(int resid) Return the type name for a given resource identifier.
String	getString(int id) Return the string value associated with a particular resource ID.
String	getString(int id, Object... formatArgs) Return the string value associated with a particular resource ID, substituting the format arguments as defined in Formatter and String.format(java.lang.String, java.lang.Object...).
String[]	getStringArray(int id) Return the string array associated with a particular resource ID.
CharSequence	getText(int id) Return the string value associated with a particular resource ID.
CharSequence	getText(int id, CharSequence def) Return the string value associated with a particular resource ID.
CharSequence[]	getTextArray(int id) Return the styled text array associated with a particular resource ID.
void	getValue(int id, TypedValue outValue, boolean resolveRefs) Return the raw data associated with a particular resource ID.
void	getValue(String name, TypedValue outValue, boolean resolveRefs) Return the raw data associated with a particular resource ID.
XmlResourceParser	getXml(int id) Return an XmlResourceParser through which you can read a generic XML resource for the given resource ID.
TypedArray	obtainAttributes(AttributeSet set, int[] attrs) Retrieve a set of basic attribute values from an AttributeSet, not performing styling of them using a theme and/or style resources.
TypedArray	obtainTypedArray(int id) Return an array of heterogeneous values.
InputStream	openRawResource(int id) Open a data stream for reading a raw resource.
AssetFileDescriptor	openRawResourceFd(int id) Open a file descriptor for reading a raw resource.
void	updateConfiguration(Configuration config, DisplayMetrics metrics) Store the newly updated configuration.

Methods inherited from class android.content.res.Resources

finishPreloading, flushLayoutCache, getAssets, getSystem, newTheme, startPreloading

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MockResources

public MockResources()

Method Detail

updateConfiguration

public void updateConfiguration(Configuration config,
                                DisplayMetrics metrics)

Description copied from class: Resources

Store the newly updated configuration.

Overrides:

updateConfiguration in class Resources

getText

public CharSequence getText(int id)
                     throws Resources.NotFoundException

Description copied from class: Resources

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.

Overrides:

getText in class Resources

Parameters:

id - 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.

Returns:

CharSequence The string data associated with the resource, plus possibly styled text information.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

getQuantityText

public CharSequence getQuantityText(int id,
                                    int quantity)
                             throws Resources.NotFoundException

Overrides:

getQuantityText in class Resources

Parameters:

id - 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.

Returns:

CharSequence The string data associated with the resource, plus possibly styled text information.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

getString

public String getString(int id)
                 throws Resources.NotFoundException

Description copied from class: Resources

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

Overrides:

getString in class Resources

Parameters:

id - 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.

Returns:

String The string data associated with the resource, stripped of styled text information.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

getString

public String getString(int id,
                        Object... formatArgs)
                 throws Resources.NotFoundException

Description copied from class: Resources

Return the string value associated with a particular resource ID, substituting the format arguments as defined in Formatter and String.format(java.lang.String, java.lang.Object...). It will be stripped of any styled text information.

Overrides:

getString in class Resources

Parameters:

id - 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 - The format arguments that will be used for substitution.

Returns:

String The string data associated with the resource, stripped of styled text information.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

getQuantityString

public String getQuantityString(int id,
                                int quantity,
                                Object... formatArgs)
                         throws Resources.NotFoundException

Description copied from class: Resources

Return the string value associated with a particular resource ID for a particular numerical quantity, substituting the format arguments as defined in Formatter and String.format(java.lang.String, java.lang.Object...). It will be stripped of any styled text information.

Overrides:

getQuantityString in class Resources

Parameters:

id - 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 - The number used to get the correct string for the current language's plural rules.

formatArgs - The format arguments that will be used for substitution.

Returns:

String The string data associated with the resource, stripped of styled text information.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

getQuantityString

public String getQuantityString(int id,
                                int quantity)
                         throws Resources.NotFoundException

Description copied from class: Resources

Return the string value associated with a particular resource ID for a particular numerical quantity.

Overrides:

getQuantityString in class Resources

Parameters:

id - 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 - The number used to get the correct string for the current language's plural rules.

Returns:

String The string data associated with the resource, stripped of styled text information.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

getText

public CharSequence getText(int id,
                            CharSequence def)

Description copied from class: Resources

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.

Overrides:

getText in class Resources

Parameters:

id - 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 - The default CharSequence to return.

Returns:

CharSequence The string data associated with the resource, plus possibly styled text information, or def if id is 0 or not found.

getTextArray

public CharSequence[] getTextArray(int id)
                            throws Resources.NotFoundException

Description copied from class: Resources

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

Overrides:

getTextArray in class Resources

Parameters:

id - 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.

Returns:

The styled text array associated with the resource.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

getStringArray

public String[] getStringArray(int id)
                        throws Resources.NotFoundException

Description copied from class: Resources

Return the string array associated with a particular resource ID.

Overrides:

getStringArray in class Resources

Parameters:

id - 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.

Returns:

The string array associated with the resource.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

getIntArray

public int[] getIntArray(int id)
                  throws Resources.NotFoundException

Description copied from class: Resources

Return the int array associated with a particular resource ID.

Overrides:

getIntArray in class Resources

Parameters:

id - 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.

Returns:

The int array associated with the resource.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

obtainTypedArray

public TypedArray obtainTypedArray(int id)
                            throws Resources.NotFoundException

Description copied from class: Resources

Return an array of heterogeneous values.

Overrides:

obtainTypedArray in class Resources

Parameters:

id - 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.

Returns:

Returns a TypedArray holding an array of the array values. Be sure to call TypedArray.recycle() when done with it.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

getDimension

public float getDimension(int id)
                   throws Resources.NotFoundException

Description copied from class: Resources

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

Overrides:

getDimension in class Resources

Parameters:

id - 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.

Returns:

Resource dimension value multiplied by the appropriate metric.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

See Also:

Resources.getDimensionPixelOffset(int), Resources.getDimensionPixelSize(int)

getDimensionPixelOffset

public int getDimensionPixelOffset(int id)
                            throws Resources.NotFoundException

Description copied from class: Resources

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

Overrides:

getDimensionPixelOffset in class Resources

Parameters:

id - 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.

Returns:

Resource dimension value multiplied by the appropriate metric and truncated to integer pixels.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

See Also:

Resources.getDimension(int), Resources.getDimensionPixelSize(int)

getDimensionPixelSize

public int getDimensionPixelSize(int id)
                          throws Resources.NotFoundException

Description copied from class: Resources

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

Overrides:

getDimensionPixelSize in class Resources

Parameters:

id - 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.

Returns:

Resource dimension value multiplied by the appropriate metric and truncated to integer pixels.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

See Also:

Resources.getDimension(int), Resources.getDimensionPixelOffset(int)

getDrawable

public Drawable getDrawable(int id)
                     throws Resources.NotFoundException

Description copied from class: Resources

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.

Overrides:

getDrawable in class Resources

Parameters:

id - 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.

Returns:

Drawable An object that can be used to draw this resource.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

getMovie

public Movie getMovie(int id)
               throws Resources.NotFoundException

Description copied from class: Resources

Return a movie object associated with the particular resource ID.

Overrides:

getMovie in class Resources

Parameters:

id - 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.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

getColor

public int getColor(int id)
             throws Resources.NotFoundException

Description copied from class: Resources

Return 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.

Overrides:

getColor in class Resources

Parameters:

id - 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.

Returns:

Returns a single color value in the form 0xAARRGGBB.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

getColorStateList

public ColorStateList getColorStateList(int id)
                                 throws Resources.NotFoundException

Description copied from class: Resources

Return 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.

Overrides:

getColorStateList in class Resources

Parameters:

id - 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.

Returns:

Returns a ColorStateList object containing either a single solid color or multiple colors that can be selected based on a state.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

getInteger

public int getInteger(int id)
               throws Resources.NotFoundException

Description copied from class: Resources

Return an integer associated with a particular resource ID.

Overrides:

getInteger in class Resources

Parameters:

id - 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.

Returns:

Returns the integer value contained in the resource.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

getLayout

public XmlResourceParser getLayout(int id)
                            throws Resources.NotFoundException

Description copied from class: Resources

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 Resources.getXml(int) with a layout resource.

Overrides:

getLayout in class Resources

Parameters:

id - 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.

Returns:

A new parser object through which you can read the XML data.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

See Also:

Resources.getXml(int)

getAnimation

public XmlResourceParser getAnimation(int id)
                               throws Resources.NotFoundException

Description copied from class: Resources

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 Resources.getXml(int) with an animation resource.

Overrides:

getAnimation in class Resources

Parameters:

id - 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.

Returns:

A new parser object through which you can read the XML data.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

See Also:

Resources.getXml(int)

getXml

public XmlResourceParser getXml(int id)
                         throws Resources.NotFoundException

Description copied from class: Resources

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).

Overrides:

getXml in class Resources

Parameters:

id - 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.

Returns:

A new parser object through which you can read the XML data.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

See Also:

AttributeSet

openRawResource

public InputStream openRawResource(int id)
                            throws Resources.NotFoundException

Description copied from class: Resources

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.

Overrides:

openRawResource in class Resources

Parameters:

id - The resource identifier to open, as generated by the appt tool.

Returns:

InputStream Access to the resource data.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

openRawResourceFd

public AssetFileDescriptor openRawResourceFd(int id)
                                      throws Resources.NotFoundException

Description copied from class: Resources

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.

Overrides:

openRawResourceFd in class Resources

Parameters:

id - The resource identifier to open, as generated by the appt tool.

Returns:

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.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

getValue

public void getValue(int id,
                     TypedValue outValue,
                     boolean resolveRefs)
              throws Resources.NotFoundException

Description copied from class: Resources

Return the raw data associated with a particular resource ID.

Overrides:

getValue in class Resources

Parameters:

id - 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 - Object in which to place the resource data.

resolveRefs - 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.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

getValue

public void getValue(String name,
                     TypedValue outValue,
                     boolean resolveRefs)
              throws Resources.NotFoundException

Description copied from class: Resources

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.

Overrides:

getValue in class Resources

Parameters:

name - The name of the desired resource. This is passed to getIdentifier() with a default type of "string".

outValue - Object in which to place the resource data.

resolveRefs - 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.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

obtainAttributes

public TypedArray obtainAttributes(AttributeSet set,
                                   int[] attrs)

Description copied from class: Resources

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

Overrides:

obtainAttributes in class Resources

Parameters:

set - The current attribute values to retrieve.

attrs - The specific attributes to be retrieved.

Returns:

Returns a TypedArray holding an array of the attribute values. Be sure to call TypedArray.recycle() when done with it.

See Also:

Resources.Theme.obtainStyledAttributes(AttributeSet, int[], int, int)

getDisplayMetrics

public DisplayMetrics getDisplayMetrics()

Description copied from class: Resources

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

Overrides:

getDisplayMetrics in class Resources

Returns:

The resource's current display metrics.

getConfiguration

public Configuration getConfiguration()

Description copied from class: Resources

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

Overrides:

getConfiguration in class Resources

Returns:

The resource's current configuration.

getIdentifier

public int getIdentifier(String name,
                         String defType,
                         String defPackage)

Description copied from class: Resources

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.

Overrides:

getIdentifier in class Resources

Parameters:

name - The name of the desired resource.

defType - Optional default resource type to find, if "type/" is not included in the name. Can be null to require an explicit type.

defPackage - Optional default package to find, if "package:" is not included in the name. Can be null to require an explicit package.

Returns:

int The associated resource identifier. Returns 0 if no such resource was found. (0 is not a valid resource ID.)

getResourceName

public String getResourceName(int resid)
                       throws Resources.NotFoundException

Description copied from class: Resources

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

Overrides:

getResourceName in class Resources

Parameters:

resid - The resource identifier whose name is to be retrieved.

Returns:

A string holding the name of the resource.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

See Also:

Resources.getResourcePackageName(int), Resources.getResourceTypeName(int), Resources.getResourceEntryName(int)

getResourcePackageName

public String getResourcePackageName(int resid)
                              throws Resources.NotFoundException

Description copied from class: Resources

Return the package name for a given resource identifier.

Overrides:

getResourcePackageName in class Resources

Parameters:

resid - The resource identifier whose package name is to be retrieved.

Returns:

A string holding the package name of the resource.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

See Also:

Resources.getResourceName(int)

getResourceTypeName

public String getResourceTypeName(int resid)
                           throws Resources.NotFoundException

Description copied from class: Resources

Return the type name for a given resource identifier.

Overrides:

getResourceTypeName in class Resources

Parameters:

resid - The resource identifier whose type name is to be retrieved.

Returns:

A string holding the type name of the resource.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

See Also:

Resources.getResourceName(int)

getResourceEntryName

public String getResourceEntryName(int resid)
                            throws Resources.NotFoundException

Description copied from class: Resources

Return the entry name for a given resource identifier.

Overrides:

getResourceEntryName in class Resources

Parameters:

resid - The resource identifier whose entry name is to be retrieved.

Returns:

A string holding the entry name of the resource.

Throws:

Resources.NotFoundException - Throws NotFoundException if the given ID does not exist.

See Also:

Resources.getResourceName(int)