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 String	DEFAULT
static String	DEFAULT_ASSET_FOLDER
static String	DEFAULT_BUILD_FOLDER
static String	DEFAULT_RES_FOLDER
static String	NONE

Optional Element Summary

Optional Elements

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

Field Detail

NONE

public static final String NONE

DEFAULT

public static final String DEFAULT

DEFAULT_RES_FOLDER

public static final String DEFAULT_RES_FOLDER

DEFAULT_ASSET_FOLDER

public static final String DEFAULT_ASSET_FOLDER

DEFAULT_BUILD_FOLDER

public static final String DEFAULT_BUILD_FOLDER

Element Detail

sdk

public abstract int[] sdk

The Android SDK level to emulate. If not specified, Robolectric defaults to API 16. This value will also be set as Build.VERSION.SDK_INT.

Returns:

The Android SDK level to emulate.

Default:

{}

manifest

public abstract 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 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 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:

android.app.Application.class

packageName

public abstract 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 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 String qualifiers

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

Returns:

Qualifiers used for resource resolution.

Default:

""

resourceDir

public abstract 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 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 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 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 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 String[] libraries

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

Returns:

A list of Android Libraries.

Default:

{}