Fixed the error prone warnings and formatted according to google's java format for annotation module
diff --git a/annotations/src/main/java/org/robolectric/annotation/Config.java b/annotations/src/main/java/org/robolectric/annotation/Config.java
index f25ff0d..fed0032 100644
--- a/annotations/src/main/java/org/robolectric/annotation/Config.java
+++ b/annotations/src/main/java/org/robolectric/annotation/Config.java
@@ -16,9 +16,7 @@
import java.util.Set;
import javax.annotation.Nonnull;
-/**
- * Configuration settings that can be used on a per-class or per-test basis.
- */
+/** Configuration settings that can be used on a per-class or per-test basis. */
@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@@ -26,12 +24,13 @@
@SuppressWarnings(value = {"BadAnnotationImplementation", "ImmutableAnnotationChecker"})
public @interface Config {
/**
- * TODO(vnayar): Create named constants for default values instead of magic numbers.
- * Array named constants must be avoided in order to dodge a JDK 1.7 bug.
- * error: annotation Config is missing value for the attribute <clinit>
- * See <a href="https://bugs.openjdk.java.net/browse/JDK-8013485">JDK-8013485</a>.
+ * TODO(vnayar): Create named constants for default values instead of magic numbers. Array named
+ * constants must be avoided in order to dodge a JDK 1.7 bug. error: annotation Config is missing
+ * value for the attribute <clinit> See <a
+ * href="https://bugs.openjdk.java.net/browse/JDK-8013485">JDK-8013485</a>.
*/
String NONE = "--none";
+
String DEFAULT_VALUE_STRING = "--default";
int DEFAULT_VALUE_INT = -1;
@@ -47,44 +46,39 @@
int OLDEST_SDK = -4;
int NEWEST_SDK = -5;
- /**
- * The Android SDK level to emulate. This value will also be set as Build.VERSION.SDK_INT.
- */
- int[] sdk() default {}; // DEFAULT_SDK
+ /** The Android SDK level to emulate. This value will also be set as Build.VERSION.SDK_INT. */
+ int[] sdk() default {}; // DEFAULT_SDK
- /**
- * The minimum Android SDK level to emulate when running tests on multiple API versions.
- */
+ /** The minimum Android SDK level to emulate when running tests on multiple API versions. */
int minSdk() default -1;
- /**
- * The maximum Android SDK level to emulate when running tests on multiple API versions.
- */
+ /** The maximum Android SDK level to emulate when running tests on multiple API versions. */
int maxSdk() default -1;
/**
* 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 {@code AndroidManifest.xml}.
+ * <p>If not specified, Robolectric defaults to {@code AndroidManifest.xml}.
*
- * If your project has no manifest or resources, use {@link Config#NONE}.
+ * <p>If your project has no manifest or resources, use {@link Config#NONE}.
+ *
* @deprecated If you are using at least Android Studio 3.0 alpha 5 or Bazel's android_local_test
- * please migrate to the preferred way to configure
- * builds http://robolectric.org/getting-started/
- *
+ * please migrate to the preferred way to configure builds
+ * http://robolectric.org/getting-started/
* @return The Android manifest file to load.
*/
@Deprecated
String manifest() default DEFAULT_VALUE_STRING;
/**
- * The {@link android.app.Application} class to use in the test, this takes precedence over any application
- * specified in the AndroidManifest.xml.
+ * The {@link android.app.Application} class to use in the test, this takes precedence over any
+ * application specified in the AndroidManifest.xml.
*
* @return The {@link android.app.Application} class to use in the test.
*/
- Class<? extends Application> application() default DefaultApplication.class; // DEFAULT_APPLICATION
+ Class<? extends Application> application() default
+ DefaultApplication.class; // DEFAULT_APPLICATION
/**
* Java package name where the "R.class" file is located. This only needs to be specified if you
@@ -99,7 +93,8 @@
* name encoded in the arsc resources file. If you are looking to simulate another application
* you can create another applications Context using {@link
* android.content.Context#createPackageContext(String, int)}. Note that you must add this
- * package to {@link org.robolectric.shadows.ShadowPackageManager#addPackage(android.content.pm.PackageInfo)}
+ * package to {@link
+ * org.robolectric.shadows.ShadowPackageManager#addPackage(android.content.pm.PackageInfo)}
* first.
*/
@Deprecated
@@ -118,24 +113,26 @@
String qualifiers() default DEFAULT_QUALIFIERS;
/**
- * The directory from which to load resources. This should be relative to the directory containing AndroidManifest.xml.
+ * The directory from which to load resources. This should be relative to the directory containing
+ * AndroidManifest.xml.
*
- * If not specified, Robolectric defaults to {@code res}.
+ * <p>If not specified, Robolectric defaults to {@code res}.
+ *
* @deprecated If you are using at least Android Studio 3.0 alpha 5 or Bazel's android_local_test
- * please migrate to the preferred way to configure
- *
+ * please migrate to the preferred way to configure
* @return Android resource directory.
*/
@Deprecated
String resourceDir() default DEFAULT_RES_FOLDER;
/**
- * The directory from which to load assets. This should be relative to the directory containing AndroidManifest.xml.
+ * The directory from which to load assets. This should be relative to the directory containing
+ * AndroidManifest.xml.
*
- * If not specified, Robolectric defaults to {@code assets}.
+ * <p>If not specified, Robolectric defaults to {@code assets}.
+ *
* @deprecated If you are using at least Android Studio 3.0 alpha 5 or Bazel's android_local_test
- * please migrate to the preferred way to configure
- *
+ * please migrate to the preferred way to configure
* @return Android asset directory.
*/
@Deprecated
@@ -146,25 +143,24 @@
*
* @return A list of additional shadow classes to enable.
*/
- Class<?>[] shadows() default {}; // DEFAULT_SHADOWS
+ Class<?>[] shadows() default {}; // DEFAULT_SHADOWS
/**
* A list of instrumented packages, in addition to those that are already instrumented.
*
* @return A list of additional instrumented packages.
*/
- String[] instrumentedPackages() default {}; // DEFAULT_INSTRUMENTED_PACKAGES
+ String[] instrumentedPackages() default {}; // DEFAULT_INSTRUMENTED_PACKAGES
/**
* A list of folders containing Android Libraries on which this project depends.
*
* @deprecated If you are using at least Android Studio 3.0 alpha 5 or Bazel's android_local_test
- * please migrate to the preferred way to configure
- *
+ * please migrate to the preferred way to configure
* @return A list of Android Libraries.
*/
@Deprecated
- String[] libraries() default {}; // DEFAULT_LIBRARIES;
+ String[] libraries() default {}; // DEFAULT_LIBRARIES;
class Implementation implements Config {
private final int[] sdk;
@@ -255,8 +251,9 @@
private static void validate(Config config) {
//noinspection ConstantConditions
- if (config.sdk() != null && config.sdk().length > 0 &&
- (config.minSdk() != DEFAULT_VALUE_INT || config.maxSdk() != DEFAULT_VALUE_INT)) {
+ if (config.sdk() != null
+ && config.sdk().length > 0
+ && (config.minSdk() != DEFAULT_VALUE_INT || config.maxSdk() != DEFAULT_VALUE_INT)) {
throw new IllegalArgumentException(
"sdk and minSdk/maxSdk may not be specified together"
+ " (sdk="
@@ -268,9 +265,16 @@
+ ")");
}
- if (config.minSdk() > DEFAULT_VALUE_INT && config.maxSdk() > DEFAULT_VALUE_INT && config.minSdk() > config.maxSdk()) {
- throw new IllegalArgumentException("minSdk may not be larger than maxSdk" +
- " (minSdk=" + config.minSdk() + ", maxSdk=" + config.maxSdk() + ")");
+ if (config.minSdk() > DEFAULT_VALUE_INT
+ && config.maxSdk() > DEFAULT_VALUE_INT
+ && config.minSdk() > config.maxSdk()) {
+ throw new IllegalArgumentException(
+ "minSdk may not be larger than maxSdk"
+ + " (minSdk="
+ + config.minSdk()
+ + ", maxSdk="
+ + config.maxSdk()
+ + ")");
}
}
@@ -363,7 +367,8 @@
return libraries;
}
- @Nonnull @Override
+ @Nonnull
+ @Override
public Class<? extends Annotation> annotationType() {
return Config.class;
}
@@ -371,18 +376,35 @@
@Override
public String toString() {
return "Implementation{"
- + "sdk=" + Arrays.toString(sdk)
- + ", minSdk=" + minSdk
- + ", maxSdk=" + maxSdk
- + ", manifest='" + manifest + '\''
- + ", qualifiers='" + qualifiers + '\''
- + ", resourceDir='" + resourceDir + '\''
- + ", assetDir='" + assetDir + '\''
- + ", packageName='" + packageName + '\''
- + ", shadows=" + Arrays.toString(shadows)
- + ", instrumentedPackages=" + Arrays.toString(instrumentedPackages)
- + ", application=" + application
- + ", libraries=" + Arrays.toString(libraries)
+ + "sdk="
+ + Arrays.toString(sdk)
+ + ", minSdk="
+ + minSdk
+ + ", maxSdk="
+ + maxSdk
+ + ", manifest='"
+ + manifest
+ + '\''
+ + ", qualifiers='"
+ + qualifiers
+ + '\''
+ + ", resourceDir='"
+ + resourceDir
+ + '\''
+ + ", assetDir='"
+ + assetDir
+ + '\''
+ + ", packageName='"
+ + packageName
+ + '\''
+ + ", shadows="
+ + Arrays.toString(shadows)
+ + ", instrumentedPackages="
+ + Arrays.toString(instrumentedPackages)
+ + ", application="
+ + application
+ + ", libraries="
+ + Arrays.toString(libraries)
+ '}';
}
}
@@ -401,8 +423,7 @@
protected Class<? extends Application> application = DEFAULT_APPLICATION;
protected String[] libraries = new String[0];
- public Builder() {
- }
+ public Builder() {}
public Builder(Config config) {
sdk = config.sdk();
@@ -480,8 +501,8 @@
}
/**
- * This returns actual default values where they exist, in the sense that we could use
- * the values, rather than markers like {@code -1} or {@code --default}.
+ * This returns actual default values where they exist, in the sense that we could use the
+ * values, rather than markers like {@code -1} or {@code --default}.
*/
public static Builder defaults() {
return new Builder()
@@ -521,7 +542,8 @@
}
this.packageName = pick(this.packageName, overlayConfig.packageName(), "");
- this.resourceDir = pick(this.resourceDir, overlayConfig.resourceDir(), Config.DEFAULT_RES_FOLDER);
+ this.resourceDir =
+ pick(this.resourceDir, overlayConfig.resourceDir(), Config.DEFAULT_RES_FOLDER);
this.assetDir = pick(this.assetDir, overlayConfig.assetDir(), Config.DEFAULT_ASSET_FOLDER);
List<Class<?>> shadows = new ArrayList<>(Arrays.asList(this.shadows));
@@ -531,7 +553,8 @@
Set<String> instrumentedPackages = new HashSet<>();
instrumentedPackages.addAll(Arrays.asList(this.instrumentedPackages));
instrumentedPackages.addAll(Arrays.asList(overlayConfig.instrumentedPackages()));
- this.instrumentedPackages = instrumentedPackages.toArray(new String[instrumentedPackages.size()]);
+ this.instrumentedPackages =
+ instrumentedPackages.toArray(new String[instrumentedPackages.size()]);
this.application = pick(this.application, overlayConfig.application(), DEFAULT_APPLICATION);
@@ -544,7 +567,9 @@
}
private <T> T pick(T baseValue, T overlayValue, T nullValue) {
- return overlayValue != null ? (overlayValue.equals(nullValue) ? baseValue : overlayValue) : null;
+ return overlayValue != null
+ ? (overlayValue.equals(nullValue) ? baseValue : overlayValue)
+ : null;
}
private int[] pickSdk(int[] baseValue, int[] overlayValue, int[] nullValue) {
@@ -568,7 +593,8 @@
}
public static boolean isDefaultApplication(Class<? extends Application> clazz) {
- return clazz == null || clazz.getCanonicalName().equals(DEFAULT_APPLICATION.getCanonicalName());
+ return clazz == null
+ || clazz.getCanonicalName().equals(DEFAULT_APPLICATION.getCanonicalName());
}
}
}
diff --git a/annotations/src/main/java/org/robolectric/annotation/GetInstallerPackageNameMode.java b/annotations/src/main/java/org/robolectric/annotation/GetInstallerPackageNameMode.java
index d26499a..e3fd6d3 100644
--- a/annotations/src/main/java/org/robolectric/annotation/GetInstallerPackageNameMode.java
+++ b/annotations/src/main/java/org/robolectric/annotation/GetInstallerPackageNameMode.java
@@ -7,18 +7,18 @@
import java.lang.annotation.Target;
/**
- * A {@link org.robolectric.pluginapi.config.Configurer} annotation for controlling how
- * Robolectric executes {@code PackageManager#getInstallerPackageName} method.
+ * A {@link org.robolectric.pluginapi.config.Configurer} annotation for controlling how Robolectric
+ * executes {@code PackageManager#getInstallerPackageName} method.
*
- * 'getInstallerPackageName' method in PackageManager must throw IllegalArgumentException if the
+ * <p>'getInstallerPackageName' method in PackageManager must throw IllegalArgumentException if the
* installer package is not present. The legacy robolectric behavior returns a null value for these
* cases.
*
- * This annotation can be applied to tests to have Robolectric perform the legacy mechanism of
+ * <p>This annotation can be applied to tests to have Robolectric perform the legacy mechanism of
* not throwing IllegalArgumentException and instead return 'null', when installer package name is
* not found.
*
- * This annotation will be deleted in a forthcoming Robolectric release.
+ * <p>This annotation will be deleted in a forthcoming Robolectric release.
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@@ -29,13 +29,9 @@
* Specifies the different {@code ShadowApplicationPackageManager#getInstallerPackageName} modes.
*/
enum Mode {
- /**
- * Robolectric's prior behavior when calling getInstallerPackageName method.
- */
+ /** Robolectric's prior behavior when calling getInstallerPackageName method. */
LEGACY,
- /**
- * The new, real behavior when calling getInstallerPackageName method.
- */
+ /** The new, real behavior when calling getInstallerPackageName method. */
REALISTIC,
}
diff --git a/annotations/src/main/java/org/robolectric/annotation/HiddenApi.java b/annotations/src/main/java/org/robolectric/annotation/HiddenApi.java
index a5e658e..cd21e9e 100644
--- a/annotations/src/main/java/org/robolectric/annotation/HiddenApi.java
+++ b/annotations/src/main/java/org/robolectric/annotation/HiddenApi.java
@@ -6,11 +6,8 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-/**
- * Indicates that the annotated method is hidden in the public Android API.
- */
+/** Indicates that the annotated method is hidden in the public Android API. */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
-public @interface HiddenApi {
-}
+public @interface HiddenApi {}
diff --git a/annotations/src/main/java/org/robolectric/annotation/Implementation.java b/annotations/src/main/java/org/robolectric/annotation/Implementation.java
index 84262b8..a041c27 100644
--- a/annotations/src/main/java/org/robolectric/annotation/Implementation.java
+++ b/annotations/src/main/java/org/robolectric/annotation/Implementation.java
@@ -7,8 +7,8 @@
import java.lang.annotation.Target;
/**
- * Indicates that a method declaration is intended to shadow a method with the same signature
- * on the associated Android class.
+ * Indicates that a method declaration is intended to shadow a method with the same signature on the
+ * associated Android class.
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@@ -16,13 +16,9 @@
public @interface Implementation {
int DEFAULT_SDK = -1;
- /**
- * The annotated shadow method will be invoked only for the specified SDK or greater.
- */
+ /** The annotated shadow method will be invoked only for the specified SDK or greater. */
int minSdk() default DEFAULT_SDK;
- /**
- * The annotated shadow method will be invoked only for the specified SDK or lesser.
- */
+ /** The annotated shadow method will be invoked only for the specified SDK or lesser. */
int maxSdk() default DEFAULT_SDK;
}
diff --git a/annotations/src/main/java/org/robolectric/annotation/Implements.java b/annotations/src/main/java/org/robolectric/annotation/Implements.java
index 422affb..2d289a7 100644
--- a/annotations/src/main/java/org/robolectric/annotation/Implements.java
+++ b/annotations/src/main/java/org/robolectric/annotation/Implements.java
@@ -8,10 +8,9 @@
import org.robolectric.shadow.api.ShadowPicker;
/**
- * Indicates that a class declaration is intended to shadow an Android class declaration.
- * The Robolectric runtime searches classes with this annotation for methods with the
- * {@link Implementation} annotation and calls them in place of the methods on the Android
- * class.
+ * Indicates that a class declaration is intended to shadow an Android class declaration. The
+ * Robolectric runtime searches classes with this annotation for methods with the {@link
+ * Implementation} annotation and calls them in place of the methods on the Android class.
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@@ -55,14 +54,10 @@
*/
boolean looseSignatures() default false;
- /**
- * If specified, the shadow class will be applied only for this SDK or greater.
- */
+ /** If specified, the shadow class will be applied only for this SDK or greater. */
int minSdk() default -1;
- /**
- * If specified, the shadow class will be applied only for this SDK or lesser.
- */
+ /** If specified, the shadow class will be applied only for this SDK or lesser. */
int maxSdk() default -1;
/**
@@ -72,6 +67,5 @@
*/
Class<? extends ShadowPicker<?>> shadowPicker() default DefaultShadowPicker.class;
- interface DefaultShadowPicker extends ShadowPicker<Object> {
- }
+ interface DefaultShadowPicker extends ShadowPicker<Object> {}
}
diff --git a/annotations/src/main/java/org/robolectric/annotation/LooperMode.java b/annotations/src/main/java/org/robolectric/annotation/LooperMode.java
index ea8ae1e..264d6cc 100644
--- a/annotations/src/main/java/org/robolectric/annotation/LooperMode.java
+++ b/annotations/src/main/java/org/robolectric/annotation/LooperMode.java
@@ -14,17 +14,16 @@
* overridden by applying a @LooperMode(NewMode) annotation to a test package, test class, or test
* method, or via the 'robolectric.looperMode' system property.
*
- * @see {@link org.robolectric.plugins.LooperModeConfigurer}, {@link
- * org.robolectric.util.Scheduler}, {@link org.robolectric.shadows.ShadowLooper}
+ * @see org.robolectric.plugins.LooperModeConfigurer
+ * @see org.robolectric.util.Scheduler
+ * @see org.robolectric.shadows.ShadowLooper
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.PACKAGE, ElementType.TYPE, ElementType.METHOD})
public @interface LooperMode {
- /**
- * Specifies the different supported Looper modes.
- */
+ /** Specifies the different supported Looper modes. */
enum Mode {
/**
* Robolectric's default threading model prior to 4.4.
@@ -126,8 +125,6 @@
// RUNNING
}
- /**
- * Set the Looper mode.
- */
+ /** Set the Looper mode. */
Mode value();
}
diff --git a/annotations/src/main/java/org/robolectric/annotation/RealObject.java b/annotations/src/main/java/org/robolectric/annotation/RealObject.java
index 6040077..431d11d 100644
--- a/annotations/src/main/java/org/robolectric/annotation/RealObject.java
+++ b/annotations/src/main/java/org/robolectric/annotation/RealObject.java
@@ -6,11 +6,8 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-/**
- * Shadow fields annotated @RealObject will have the real instance injected.
- */
+/** Shadow fields annotated @RealObject will have the real instance injected. */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
-public @interface RealObject {
-}
+public @interface RealObject {}
diff --git a/annotations/src/main/java/org/robolectric/annotation/Resetter.java b/annotations/src/main/java/org/robolectric/annotation/Resetter.java
index 1884209..e5972f4 100644
--- a/annotations/src/main/java/org/robolectric/annotation/Resetter.java
+++ b/annotations/src/main/java/org/robolectric/annotation/Resetter.java
@@ -6,11 +6,8 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-/**
- * Indicates that the annotated method is used to reset static state in a shadow.
- */
+/** Indicates that the annotated method is used to reset static state in a shadow. */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
-public @interface Resetter {
-}
+public @interface Resetter {}
diff --git a/annotations/src/main/java/org/robolectric/annotation/TextLayoutMode.java b/annotations/src/main/java/org/robolectric/annotation/TextLayoutMode.java
index c263c34..9525d32 100644
--- a/annotations/src/main/java/org/robolectric/annotation/TextLayoutMode.java
+++ b/annotations/src/main/java/org/robolectric/annotation/TextLayoutMode.java
@@ -7,18 +7,18 @@
import java.lang.annotation.Target;
/**
- * A {@link org.robolectric.pluginapi.config.Configurer} annotation for controlling how
- * Robolectric performs UI layout.
+ * A {@link org.robolectric.pluginapi.config.Configurer} annotation for controlling how Robolectric
+ * performs UI layout.
*
- * PR #4818 changed Robolectric to be more realistic when performing layout on Android views.
+ * <p>PR #4818 changed Robolectric to be more realistic when performing layout on Android views.
* This change in behavior could cause tests still using the legacy 'UNPAUSED' looper mode or
* relying on views being a specific size to fail.
*
- * This annotation can be applied to tests to have Robolectric perform the legacy, less accurate
+ * <p>This annotation can be applied to tests to have Robolectric perform the legacy, less accurate
* mechanism of laying out and measuring Android text views, as a stopgap until the tests can be
* properly fixed.
*
- * This annotation will be deleted in a forthcoming Robolectric release.
+ * <p>This annotation will be deleted in a forthcoming Robolectric release.
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
diff --git a/annotations/src/main/java/org/robolectric/annotation/package-info.java b/annotations/src/main/java/org/robolectric/annotation/package-info.java
index 4a71fe7..b7b9f03 100644
--- a/annotations/src/main/java/org/robolectric/annotation/package-info.java
+++ b/annotations/src/main/java/org/robolectric/annotation/package-info.java
@@ -1,4 +1,2 @@
-/**
- * Package containing Robolectric annotations.
- */
-package org.robolectric.annotation;
\ No newline at end of file
+/** Package containing Robolectric annotations. */
+package org.robolectric.annotation;
diff --git a/annotations/src/main/java/org/robolectric/shadow/api/ShadowPicker.java b/annotations/src/main/java/org/robolectric/shadow/api/ShadowPicker.java
index 25d0489..94355d0 100644
--- a/annotations/src/main/java/org/robolectric/shadow/api/ShadowPicker.java
+++ b/annotations/src/main/java/org/robolectric/shadow/api/ShadowPicker.java
@@ -4,8 +4,8 @@
public interface ShadowPicker<T> {
/**
- * Determines the shadow class to be used depending on the configuration of the
- * {@link org.robolectric.internal.Environment}. Must be deterministic.
+ * Determines the shadow class to be used depending on the configuration of the {@link
+ * org.robolectric.internal.Environment}. Must be deterministic.
*
* @return the shadow class to be used
*/
