org.robolectric.annotation

Annotation Type Config

@Documented
 @Inherited
 @Retention(value=RUNTIME)
 @Target(value={TYPE,METHOD})
public @interface Config

Configuration settings that can be used on a per-class or per-test basis.

Field Summary

Fields

Modifier and Type	Fields and Description
static int	ALL_SDKS
static java.lang.String	DEFAULT_ABI_SPLIT
static java.lang.Class<? extends android.app.Application>	DEFAULT_APPLICATION
static java.lang.String	DEFAULT_ASSET_FOLDER
static java.lang.String	DEFAULT_BUILD_FOLDER
static java.lang.String	DEFAULT_MANIFEST_NAME
static java.lang.String	DEFAULT_PACKAGE_NAME
static java.lang.String	DEFAULT_QUALIFIERS
static java.lang.String	DEFAULT_RES_FOLDER
static int	DEFAULT_VALUE_INT
static java.lang.String	DEFAULT_VALUE_STRING
static int	NEWEST_SDK
static java.lang.String	NONE TODO(vnayar): Create named constants for default values instead of magic numbers.
static int	OLDEST_SDK
static int	TARGET_SDK

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	abiSplit The ABI split to use when locating resources and AndroidManifest.xml
java.lang.Class<? extends android.app.Application>	application The Application class to use in the test, this takes precedence over any application specified in the AndroidManifest.xml.
java.lang.String	assetDir The directory from which to load assets.
java.lang.String	buildDir The directory where application files are created during the application build process.
java.lang.Class<?>	constants Reference to the BuildConfig class created by the Gradle build system.
java.lang.String[]	instrumentedPackages A list of instrumented packages, in addition to those that are already instrumented.
java.lang.String[]	libraries A list of folders containing Android Libraries on which this project depends.
java.lang.String	manifest The Android manifest file to load; Robolectric will look relative to the current directory.
int	maxSdk The minimum Android SDK level to emulate when running tests on multiple API versions.
int	minSdk The minimum Android SDK level to emulate when running tests on multiple API versions.
java.lang.String	packageName Java package name where the "R.class" file is located.
java.lang.String	qualifiers Qualifiers for the resource resolution, such as "fr-normal-port-hdpi".
java.lang.String	resourceDir The directory from which to load resources.
int[]	sdk The Android SDK level to emulate.
java.lang.Class<?>[]	shadows A list of shadow classes to enable, in addition to those that are already present.

Field Detail

NONE

public static final java.lang.String NONE

TODO(vnayar): Create named constants for default values instead of magic numbers. Array named contants must be avoided in order to dodge a JDK 1.7 bug. error: annotation Config is missing value for the attribute <clinit> See JDK-8013485.

DEFAULT_VALUE_STRING

public static final java.lang.String DEFAULT_VALUE_STRING

DEFAULT_VALUE_INT

public static final int DEFAULT_VALUE_INT

DEFAULT_MANIFEST_NAME

public static final java.lang.String DEFAULT_MANIFEST_NAME

DEFAULT_APPLICATION

public static final java.lang.Class<? extends android.app.Application> DEFAULT_APPLICATION

DEFAULT_PACKAGE_NAME

public static final java.lang.String DEFAULT_PACKAGE_NAME

DEFAULT_ABI_SPLIT

public static final java.lang.String DEFAULT_ABI_SPLIT

DEFAULT_QUALIFIERS

public static final java.lang.String DEFAULT_QUALIFIERS

DEFAULT_RES_FOLDER

public static final java.lang.String DEFAULT_RES_FOLDER

DEFAULT_ASSET_FOLDER

public static final java.lang.String DEFAULT_ASSET_FOLDER

DEFAULT_BUILD_FOLDER

public static final java.lang.String DEFAULT_BUILD_FOLDER

ALL_SDKS

public static final int ALL_SDKS

TARGET_SDK

public static final int TARGET_SDK

OLDEST_SDK

public static final int OLDEST_SDK

NEWEST_SDK

public static final int NEWEST_SDK

Element Detail

sdk

public abstract int[] sdk

The Android SDK level to emulate. This value will also be set as Build.VERSION.SDK_INT.

Default:

{}

minSdk

public abstract int minSdk

The minimum Android SDK level to emulate when running tests on multiple API versions.

Default:

-1

maxSdk

public abstract int maxSdk

The minimum Android SDK level to emulate when running tests on multiple API versions.

Default:

-1

manifest

public abstract java.lang.String manifest

The Android manifest file to load; Robolectric will look relative to the current directory. Resources and assets will be loaded relative to the manifest. If not specified, Robolectric defaults to AndroidManifest.xml. If your project has no manifest or resources, use NONE.

Returns:

The Android manifest file to load.

Default:

"--default"

constants

public abstract java.lang.Class<?> constants

Reference to the BuildConfig class created by the Gradle build system.

Returns:

Reference to BuildConfig class.

Default:

java.lang.Void.class

application

public abstract java.lang.Class<? extends android.app.Application> application

The Application class to use in the test, this takes precedence over any application specified in the AndroidManifest.xml.

Returns:

The Application class to use in the test.

Default:

org.robolectric.annotation.DefaultApplication.class

packageName

public abstract java.lang.String packageName

Java package name where the "R.class" file is located. This only needs to be specified if you define an applicationId associated with productFlavors or specify applicationIdSuffix in your build.gradle.

If not specified, Robolectric defaults to the applicationId.

Returns:

The java package name for R.class.

Default:

""

abiSplit

public abstract java.lang.String abiSplit

The ABI split to use when locating resources and AndroidManifest.xml

You do not typically have to set this, unless you are utilizing the ABI split feature

Returns:

The ABI split to test with

Default:

""

qualifiers

public abstract java.lang.String qualifiers

Qualifiers for the resource resolution, such as "fr-normal-port-hdpi".

Returns:

Qualifiers used for resource resolution.

Default:

""

resourceDir

public abstract java.lang.String resourceDir

The directory from which to load resources. This should be relative to the directory containing AndroidManifest.xml.

If not specified, Robolectric defaults to res.

Returns:

Android resource directory.

Default:

"res"

assetDir

public abstract java.lang.String assetDir

The directory from which to load assets. This should be relative to the directory containing AndroidManifest.xml.

If not specified, Robolectric defaults to assets.

Returns:

Android asset directory.

Default:

"assets"

buildDir

public abstract java.lang.String buildDir

The directory where application files are created during the application build process.

If not specified, Robolectric defaults to build.

Returns:

Android build directory.

Default:

"build"

shadows

public abstract java.lang.Class<?>[] shadows

A list of shadow classes to enable, in addition to those that are already present.

Returns:

A list of additional shadow classes to enable.

Default:

{}

instrumentedPackages

public abstract java.lang.String[] instrumentedPackages

A list of instrumented packages, in addition to those that are already instrumented.

Returns:

A list of additional instrumented packages.

Default:

{}

libraries

public abstract java.lang.String[] libraries

A list of folders containing Android Libraries on which this project depends.

Returns:

A list of Android Libraries.

Default:

{}