Address API feedback
Finish rename in comments for s/EmojiMetadata/TypefaceEmojiSpan/
Bug: b/266007895
Fixes: N/A (docs)
Change-Id: I2f1f62035de0cd5da9255f1cf536bd407b446959
diff --git a/emoji2/emoji2/src/main/java/androidx/emoji2/text/EmojiCompat.java b/emoji2/emoji2/src/main/java/androidx/emoji2/text/EmojiCompat.java
index 6426ad5..9604796 100644
--- a/emoji2/emoji2/src/main/java/androidx/emoji2/text/EmojiCompat.java
+++ b/emoji2/emoji2/src/main/java/androidx/emoji2/text/EmojiCompat.java
@@ -1189,13 +1189,14 @@
/**
* Create EmojiSpan instance.
*
- * @param metadata EmojiMetadata instance, which can draw the emoji onto a Canvas.
+ * @param rasterizer TypefaceEmojiRasterizer instance, which can draw the emoji onto a
+ * Canvas.
*
- * @return EmojiSpan instance that can use EmojiMetadata to draw emoji.
+ * @return EmojiSpan instance that can use TypefaceEmojiRasterizer to draw emoji.
*/
@RequiresApi(19)
@NonNull
- EmojiSpan createSpan(@NonNull TypefaceEmojiRasterizer metadata);
+ EmojiSpan createSpan(@NonNull TypefaceEmojiRasterizer rasterizer);
}
@@ -1208,15 +1209,16 @@
/**
* Returns a TypefaceEmojiSpan.
*
- * @param metadata EmojiMetadata instance, which can draw the emoji onto a Canvas.
+ * @param rasterizer TypefaceEmojiRasterizer instance, which can draw the emoji onto a
+ * Canvas.
*
* @return {@link TypefaceEmojiSpan}
*/
@RequiresApi(19)
@NonNull
@Override
- public EmojiSpan createSpan(@NonNull TypefaceEmojiRasterizer metadata) {
- return new TypefaceEmojiSpan(metadata);
+ public EmojiSpan createSpan(@NonNull TypefaceEmojiRasterizer rasterizer) {
+ return new TypefaceEmojiSpan(rasterizer);
}
}
diff --git a/emoji2/emoji2/src/main/java/androidx/emoji2/text/EmojiProcessor.java b/emoji2/emoji2/src/main/java/androidx/emoji2/text/EmojiProcessor.java
index 50cc247..6efcd7a 100644
--- a/emoji2/emoji2/src/main/java/androidx/emoji2/text/EmojiProcessor.java
+++ b/emoji2/emoji2/src/main/java/androidx/emoji2/text/EmojiProcessor.java
@@ -580,20 +580,20 @@
* @param charSequence the CharSequence that the emoji is in
* @param start start index of the emoji in the CharSequence
* @param end end index of the emoji in the CharSequence
- * @param metadata EmojiMetadata instance for the emoji
+ * @param rasterizer TypefaceEmojiRasterizer instance for the emoji
*
* @return {@code true} if the OS can render emoji, {@code false} otherwise
*/
private boolean hasGlyph(final CharSequence charSequence, int start, final int end,
- final TypefaceEmojiRasterizer metadata) {
+ final TypefaceEmojiRasterizer rasterizer) {
// if the existence is not calculated yet
- if (metadata.getHasGlyph() == TypefaceEmojiRasterizer.HAS_GLYPH_UNKNOWN) {
+ if (rasterizer.getHasGlyph() == TypefaceEmojiRasterizer.HAS_GLYPH_UNKNOWN) {
final boolean hasGlyph = mGlyphChecker.hasGlyph(charSequence, start, end,
- metadata.getSdkAdded());
- metadata.setHasGlyph(hasGlyph);
+ rasterizer.getSdkAdded());
+ rasterizer.setHasGlyph(hasGlyph);
}
- return metadata.getHasGlyph() == TypefaceEmojiRasterizer.HAS_GLYPH_EXISTS;
+ return rasterizer.getHasGlyph() == TypefaceEmojiRasterizer.HAS_GLYPH_EXISTS;
}
/**
diff --git a/emoji2/emoji2/src/main/java/androidx/emoji2/text/MetadataRepo.java b/emoji2/emoji2/src/main/java/androidx/emoji2/text/MetadataRepo.java
index 50e8495..f08ae06 100644
--- a/emoji2/emoji2/src/main/java/androidx/emoji2/text/MetadataRepo.java
+++ b/emoji2/emoji2/src/main/java/androidx/emoji2/text/MetadataRepo.java
@@ -50,8 +50,9 @@
private final @NonNull MetadataList mMetadataList;
/**
- * char presentation of all EmojiMetadata's in a single array. All emojis we have are mapped to
- * Private Use Area A, in the range U+F0000..U+FFFFD. Therefore each emoji takes 2 chars.
+ * char presentation of all TypefaceEmojiRasterizer's in a single array. All emojis we have are
+ * mapped to Private Use Area A, in the range U+F0000..U+FFFFD. Therefore each emoji takes 2
+ * chars.
*/
private final @NonNull char[] mEmojiCharArray;
@@ -213,7 +214,7 @@
}
/**
- * Add an EmojiMetadata to the index.
+ * Add a TypefaceEmojiRasterizer to the index.
*
* @hide
*/
@@ -228,8 +229,9 @@
}
/**
- * Trie node that holds mapping from emoji codepoint(s) to EmojiMetadata. A single codepoint
- * emoji is represented by a child of the root node.
+ * Trie node that holds mapping from emoji codepoint(s) to TypefaceEmojiRasterizer.
+ *
+ * A single codepoint emoji is represented by a child of the root node.
*
* @hide
*/
diff --git a/emoji2/emoji2/src/main/java/androidx/emoji2/text/TypefaceEmojiRasterizer.java b/emoji2/emoji2/src/main/java/androidx/emoji2/text/TypefaceEmojiRasterizer.java
index f5bbe43..f120b3c 100644
--- a/emoji2/emoji2/src/main/java/androidx/emoji2/text/TypefaceEmojiRasterizer.java
+++ b/emoji2/emoji2/src/main/java/androidx/emoji2/text/TypefaceEmojiRasterizer.java
@@ -89,7 +89,7 @@
private static final ThreadLocal<MetadataItem> sMetadataItem = new ThreadLocal<>();
/**
- * Index of the EmojiMetadata in {@link MetadataList}.
+ * Index of the TypefaceEmojiRasterizer in {@link MetadataList}.
*/
private final int mIndex;
@@ -148,7 +148,7 @@
}
/**
- * @return a ThreadLocal instance of MetadataItem for this EmojiMetadata
+ * @return a ThreadLocal instance of MetadataItem for this TypefaceEmojiRasterizer
*/
private MetadataItem getMetadataItem() {
MetadataItem result = sMetadataItem.get();
@@ -159,10 +159,11 @@
// MetadataList is a wrapper around the metadata ByteBuffer. MetadataItem is a wrapper with
// an index (pointer) on this ByteBuffer that represents a single emoji. Both are FlatBuffer
// classes that wraps a ByteBuffer and gives access to the information in it. In order not
- // to create a wrapper class for each EmojiMetadata, we use mIndex as the index of the
- // MetadataItem in the ByteBuffer. We need to reiniitalize the current thread local instance
- // by executing the statement below. All the statement does is to set an int index in
- // MetadataItem. the same instance is used by all EmojiMetadata classes in the same thread.
+ // to create a wrapper class for each TypefaceEmojiRasterizer, we use mIndex as the index
+ // of the MetadataItem in the ByteBuffer. We need to reiniitalize the current thread
+ // local instance by executing the statement below. All the statement does is to set an
+ // int index in MetadataItem. the same instance is used by all TypefaceEmojiRasterizer
+ // classes in the same thread.
mMetadataRepo.getMetadataList().list(result, mIndex);
return result;
}