diff options
author | Paul Duffin <paulduffin@google.com> | 2017-01-25 11:43:10 +0000 |
---|---|---|
committer | Paul Duffin <paulduffin@google.com> | 2017-02-06 13:38:31 +0000 |
commit | 7c757304fdf316cd276f83ac47251fc27fafd058 (patch) | |
tree | 20450ddaeccffed3d7254a742f253632088ea102 | |
parent | 5d9cc8c989815b4180a6a0bd220dbfd35e126c84 (diff) | |
download | hamcrest-7c757304fdf316cd276f83ac47251fc27fafd058.tar.gz |
Temporarily add void is(Class) to cause compile time errors
The is(Class) method was removed upstream between Hamcrest 1.1
and 1.3 in favour of the instanceOf(Class) method.
Unfortunately, existing usages of it could still compile against
the is(Object) method instead. Although not every existing usage
would compile successfully it is possible that some could and
that would result in a change in the runtime behavior that could
be difficult to detect and fix. This change aims to turn any
significant usage of this method into a compile time error.
Bug: 30946317
Test: make checkbuild
Change-Id: Ib0fac6e944b94ba8f1b5434d64549cc12f20d938
-rw-r--r-- | hamcrest-core/src/main/java/org/hamcrest/CoreMatchers.java | 20 | ||||
-rw-r--r-- | hamcrest-library/src/main/java/org/hamcrest/Matchers.java | 24 |
2 files changed, 28 insertions, 16 deletions
diff --git a/hamcrest-core/src/main/java/org/hamcrest/CoreMatchers.java b/hamcrest-core/src/main/java/org/hamcrest/CoreMatchers.java index dd36acb..400a491 100644 --- a/hamcrest-core/src/main/java/org/hamcrest/CoreMatchers.java +++ b/hamcrest-core/src/main/java/org/hamcrest/CoreMatchers.java @@ -25,13 +25,19 @@ public class CoreMatchers { } /** - * This is a shortcut to the frequently used is(instanceOf(SomeClass.class)). - * - * eg. assertThat(cheese, is(instanceOf(Cheddar.class))) - * vs assertThat(cheese, is(Cheddar.class)) - */ - public static org.hamcrest.Matcher<java.lang.Object> is(java.lang.Class<?> type) { - return org.hamcrest.core.Is.is(type); + * Provided to cause compile time error when used in preference to a possible runtime error if + * this was not here. + * + * <p>This method was removed upstream between Hamcrest 1.1 and 1.3 in favour of the + * instanceOf(Class) method. Unfortunately, existing usages of it could still compile against the + * {@link #is(Object)} method instead. Although not every existing usage would compile + * successfully it is possible that some could and that would result in a change in the runtime + * behavior that could be difficult to detect and fix. This change aims to turn any significant + * usage of this method into a compile time error. + * + * @deprecated Use instanceOf(SomeClass.class) instead. + */ + public static void is(java.lang.Class<?> type) { } /** diff --git a/hamcrest-library/src/main/java/org/hamcrest/Matchers.java b/hamcrest-library/src/main/java/org/hamcrest/Matchers.java index ce550b5..2e82aa0 100644 --- a/hamcrest-library/src/main/java/org/hamcrest/Matchers.java +++ b/hamcrest-library/src/main/java/org/hamcrest/Matchers.java @@ -24,15 +24,21 @@ public class Matchers { return org.hamcrest.core.Is.is(value); } - /** - * This is a shortcut to the frequently used is(instanceOf(SomeClass.class)). - * - * eg. assertThat(cheese, is(instanceOf(Cheddar.class))) - * vs assertThat(cheese, is(Cheddar.class)) - */ - public static org.hamcrest.Matcher<java.lang.Object> is(java.lang.Class<?> type) { - return org.hamcrest.core.Is.is(type); - } + /** + * Provided to cause compile time error when used in preference to a possible runtime error if + * this was not here. + * + * <p>This method was removed upstream between Hamcrest 1.1 and 1.3 in favour of the + * instanceOf(Class) method. Unfortunately, existing usages of it could still compile against the + * {@link #is(Object)} method instead. Although not every existing usage would compile + * successfully it is possible that some could and that would result in a change in the runtime + * behavior that could be difficult to detect and fix. This change aims to turn any significant + * usage of this method into a compile time error. + * + * @deprecated Use instanceOf(SomeClass.class) instead. + */ + public static void is(java.lang.Class<?> type) { + } /** * Inverts the rule. |