Merge "Deprecate LOAD_STATE_SUCCESS and FAILURE" into oc-support-26.0-dev
diff --git a/api/26.0.0-SNAPSHOT.txt b/api/26.0.0-SNAPSHOT.txt
index 5d7496b..c39468e 100644
--- a/api/26.0.0-SNAPSHOT.txt
+++ b/api/26.0.0-SNAPSHOT.txt
@@ -1900,9 +1900,11 @@
method public void unregisterInitCallback(android.support.text.emoji.EmojiCompat.InitCallback);
field public static final java.lang.String EDITOR_INFO_METAVERSION_KEY = "android.support.text.emoji.emojiCompat_metadataVersion";
field public static final java.lang.String EDITOR_INFO_REPLACE_ALL_KEY = "android.support.text.emoji.emojiCompat_replaceAll";
- field public static final int LOAD_STATE_FAILURE = 2; // 0x2
+ field public static final int LOAD_STATE_FAILED = 2; // 0x2
+ field public static final deprecated int LOAD_STATE_FAILURE = 2; // 0x2
field public static final int LOAD_STATE_LOADING = 0; // 0x0
- field public static final int LOAD_STATE_SUCCESS = 1; // 0x1
+ field public static final int LOAD_STATE_SUCCEEDED = 1; // 0x1
+ field public static final deprecated int LOAD_STATE_SUCCESS = 1; // 0x1
field public static final int REPLACE_STRATEGY_ALL = 1; // 0x1
field public static final int REPLACE_STRATEGY_DEFAULT = 0; // 0x0
field public static final int REPLACE_STRATEGY_NON_EXISTENT = 2; // 0x2
diff --git a/emoji/core/src/android/support/text/emoji/EmojiCompat.java b/emoji/core/src/android/support/text/emoji/EmojiCompat.java
index b5db6f6..81cd132 100644
--- a/emoji/core/src/android/support/text/emoji/EmojiCompat.java
+++ b/emoji/core/src/android/support/text/emoji/EmojiCompat.java
@@ -101,19 +101,35 @@
/**
* EmojiCompat successfully initialized.
*/
+ public static final int LOAD_STATE_SUCCEEDED = 1;
+
+ /**
+ * Use {@link #LOAD_STATE_SUCCEEDED} instead.
+ *
+ * @deprecated
+ */
+ @Deprecated
public static final int LOAD_STATE_SUCCESS = 1;
/**
* An unrecoverable error occurred during initialization of EmojiCompat. Calls to functions
* such as {@link #process(CharSequence)} will fail.
*/
+ public static final int LOAD_STATE_FAILED = 2;
+
+ /**
+ * Use {@link #LOAD_STATE_FAILED} instead.
+ *
+ * @deprecated
+ */
+ @Deprecated
public static final int LOAD_STATE_FAILURE = 2;
/**
* @hide
*/
@RestrictTo(LIBRARY_GROUP)
- @IntDef({LOAD_STATE_LOADING, LOAD_STATE_SUCCESS, LOAD_STATE_FAILURE})
+ @IntDef({LOAD_STATE_LOADING, LOAD_STATE_SUCCEEDED, LOAD_STATE_FAILED})
@Retention(RetentionPolicy.SOURCE)
public @interface LoadState {
}
@@ -209,8 +225,8 @@
/**
* Initialize the singleton instance with a configuration. When used on devices running API 18
- * or below, the singleton instance is immediately moved into {@link #LOAD_STATE_SUCCESS} state
- * without loading any metadata.
+ * or below, the singleton instance is immediately moved into {@link #LOAD_STATE_SUCCEEDED}
+ * state without loading any metadata.
*
* @see EmojiCompat.Config
*/
@@ -296,7 +312,7 @@
final Collection<InitCallback> initCallbacks = new ArrayList<>();
mInitLock.writeLock().lock();
try {
- mLoadState = LOAD_STATE_SUCCESS;
+ mLoadState = LOAD_STATE_SUCCEEDED;
initCallbacks.addAll(mInitCallbacks);
mInitCallbacks.clear();
} finally {
@@ -310,7 +326,7 @@
final Collection<InitCallback> initCallbacks = new ArrayList<>();
mInitLock.writeLock().lock();
try {
- mLoadState = LOAD_STATE_FAILURE;
+ mLoadState = LOAD_STATE_FAILED;
initCallbacks.addAll(mInitCallbacks);
mInitCallbacks.clear();
} finally {
@@ -337,7 +353,7 @@
mInitLock.writeLock().lock();
try {
- if (mLoadState == LOAD_STATE_SUCCESS || mLoadState == LOAD_STATE_FAILURE) {
+ if (mLoadState == LOAD_STATE_SUCCEEDED || mLoadState == LOAD_STATE_FAILED) {
mMainHandler.post(new ListenerDispatcher(initCallback, mLoadState));
} else {
mInitCallbacks.add(initCallback);
@@ -364,10 +380,10 @@
/**
* Returns loading state of the EmojiCompat instance. When used on devices running API 18 or
- * below always returns {@link #LOAD_STATE_SUCCESS}.
+ * below always returns {@link #LOAD_STATE_SUCCEEDED}.
*
- * @return one of {@link #LOAD_STATE_LOADING}, {@link #LOAD_STATE_SUCCESS},
- * {@link #LOAD_STATE_FAILURE}
+ * @return one of {@link #LOAD_STATE_LOADING}, {@link #LOAD_STATE_SUCCEEDED},
+ * {@link #LOAD_STATE_FAILED}
*/
public @LoadState int getLoadState() {
mInitLock.readLock().lock();
@@ -382,7 +398,7 @@
* @return {@code true} if EmojiCompat is successfully initialized
*/
private boolean isInitialized() {
- return getLoadState() == LOAD_STATE_SUCCESS;
+ return getLoadState() == LOAD_STATE_SUCCEEDED;
}
/**
@@ -884,12 +900,12 @@
public void run() {
final int size = mInitCallbacks.size();
switch (mLoadState) {
- case LOAD_STATE_SUCCESS:
+ case LOAD_STATE_SUCCEEDED:
for (int i = 0; i < size; i++) {
mInitCallbacks.get(i).onInitialized();
}
break;
- case LOAD_STATE_FAILURE:
+ case LOAD_STATE_FAILED:
default:
for (int i = 0; i < size; i++) {
mInitCallbacks.get(i).onFailed(mThrowable);
diff --git a/emoji/core/src/android/support/text/emoji/widget/EmojiInputFilter.java b/emoji/core/src/android/support/text/emoji/widget/EmojiInputFilter.java
index a1a6fc8..4dec230 100644
--- a/emoji/core/src/android/support/text/emoji/widget/EmojiInputFilter.java
+++ b/emoji/core/src/android/support/text/emoji/widget/EmojiInputFilter.java
@@ -58,7 +58,7 @@
switch (EmojiCompat.get().getLoadState()){
- case EmojiCompat.LOAD_STATE_SUCCESS:
+ case EmojiCompat.LOAD_STATE_SUCCEEDED:
boolean process = true;
if (destEnd == 0 && destStart == 0 && dest.length() == 0) {
final CharSequence oldText = mTextView.getText();
diff --git a/emoji/core/src/android/support/text/emoji/widget/EmojiTextWatcher.java b/emoji/core/src/android/support/text/emoji/widget/EmojiTextWatcher.java
index d261c0c..81bcbd3 100644
--- a/emoji/core/src/android/support/text/emoji/widget/EmojiTextWatcher.java
+++ b/emoji/core/src/android/support/text/emoji/widget/EmojiTextWatcher.java
@@ -64,7 +64,7 @@
//before > after --> a deletion occured
if (before <= after && charSequence instanceof Spannable) {
switch (EmojiCompat.get().getLoadState()){
- case EmojiCompat.LOAD_STATE_SUCCESS:
+ case EmojiCompat.LOAD_STATE_SUCCEEDED:
final Spannable s = (Spannable) charSequence;
EmojiCompat.get().process(s, start, start + after, mMaxEmojiCount);
break;
diff --git a/emoji/core/src/android/support/text/emoji/widget/EmojiTransformationMethod.java b/emoji/core/src/android/support/text/emoji/widget/EmojiTransformationMethod.java
index b7e7531..6e66462 100644
--- a/emoji/core/src/android/support/text/emoji/widget/EmojiTransformationMethod.java
+++ b/emoji/core/src/android/support/text/emoji/widget/EmojiTransformationMethod.java
@@ -52,7 +52,7 @@
if (source != null) {
switch (EmojiCompat.get().getLoadState()){
- case EmojiCompat.LOAD_STATE_SUCCESS:
+ case EmojiCompat.LOAD_STATE_SUCCEEDED:
return EmojiCompat.get().process(source);
}
}
diff --git a/emoji/core/tests/java/android/support/text/emoji/EmojiCompatTest.java b/emoji/core/tests/java/android/support/text/emoji/EmojiCompatTest.java
index 29964ce..eb4ce2e 100644
--- a/emoji/core/tests/java/android/support/text/emoji/EmojiCompatTest.java
+++ b/emoji/core/tests/java/android/support/text/emoji/EmojiCompatTest.java
@@ -589,7 +589,7 @@
@Test
@SdkSuppress(maxSdkVersion = 18)
public void testGetLoadState_returnsSuccess_pre19() {
- assertEquals(EmojiCompat.get().getLoadState(), EmojiCompat.LOAD_STATE_SUCCESS);
+ assertEquals(EmojiCompat.get().getLoadState(), EmojiCompat.LOAD_STATE_SUCCEEDED);
}
@Test
@@ -605,7 +605,7 @@
metadataLoader.getTestLatch().await();
InstrumentationRegistry.getInstrumentation().waitForIdleSync();
- assertEquals(EmojiCompat.get().getLoadState(), EmojiCompat.LOAD_STATE_SUCCESS);
+ assertEquals(EmojiCompat.get().getLoadState(), EmojiCompat.LOAD_STATE_SUCCEEDED);
}
@Test
@@ -621,7 +621,7 @@
metadataLoader.getTestLatch().await();
InstrumentationRegistry.getInstrumentation().waitForIdleSync();
- assertEquals(EmojiCompat.get().getLoadState(), EmojiCompat.LOAD_STATE_FAILURE);
+ assertEquals(EmojiCompat.get().getLoadState(), EmojiCompat.LOAD_STATE_FAILED);
}
@Test
diff --git a/emoji/core/tests/java/android/support/text/emoji/widget/EmojiInputFilterTest.java b/emoji/core/tests/java/android/support/text/emoji/widget/EmojiInputFilterTest.java
index e9c9418..ca594cf 100644
--- a/emoji/core/tests/java/android/support/text/emoji/widget/EmojiInputFilterTest.java
+++ b/emoji/core/tests/java/android/support/text/emoji/widget/EmojiInputFilterTest.java
@@ -54,7 +54,7 @@
final TextView textView = mock(TextView.class);
mEmojiCompat = mock(EmojiCompat.class);
EmojiCompat.reset(mEmojiCompat);
- when(mEmojiCompat.getLoadState()).thenReturn(EmojiCompat.LOAD_STATE_SUCCESS);
+ when(mEmojiCompat.getLoadState()).thenReturn(EmojiCompat.LOAD_STATE_SUCCEEDED);
mInputFilter = new EmojiInputFilter(textView);
}
@@ -106,7 +106,7 @@
@Test
public void testFilter_whenEmojiCompatLoadFailed() {
final Spannable testString = new SpannableString("abc");
- when(mEmojiCompat.getLoadState()).thenReturn(EmojiCompat.LOAD_STATE_FAILURE);
+ when(mEmojiCompat.getLoadState()).thenReturn(EmojiCompat.LOAD_STATE_FAILED);
final CharSequence result = mInputFilter.filter(testString, 0, 1, null, 0, 1);
diff --git a/emoji/core/tests/java/android/support/text/emoji/widget/EmojiTextWatcherTest.java b/emoji/core/tests/java/android/support/text/emoji/widget/EmojiTextWatcherTest.java
index 6fc7347..728947c 100644
--- a/emoji/core/tests/java/android/support/text/emoji/widget/EmojiTextWatcherTest.java
+++ b/emoji/core/tests/java/android/support/text/emoji/widget/EmojiTextWatcherTest.java
@@ -55,7 +55,7 @@
@Test
public void testOnTextChanged_callsProcess() {
final Spannable testString = new SpannableString("abc");
- when(mEmojiCompat.getLoadState()).thenReturn(EmojiCompat.LOAD_STATE_SUCCESS);
+ when(mEmojiCompat.getLoadState()).thenReturn(EmojiCompat.LOAD_STATE_SUCCEEDED);
mTextWatcher.onTextChanged(testString, 0, 0, 1);
@@ -78,7 +78,7 @@
@Test
public void testOnTextChanged_whenEmojiCompatLoadFailed() {
final Spannable testString = new SpannableString("abc");
- when(mEmojiCompat.getLoadState()).thenReturn(EmojiCompat.LOAD_STATE_FAILURE);
+ when(mEmojiCompat.getLoadState()).thenReturn(EmojiCompat.LOAD_STATE_FAILED);
mTextWatcher.onTextChanged(testString, 0, 0, 1);