fankes/moshi
2
0
Fork 0
mirror of https://github.com/fankes/moshi.git synced 2025-10-19 07:59:21 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Allow Object base type for PolymorphicJsonAdapterFactory. (#744)

Browse Source 
* Allow Object base type for PolymorphicJsonAdapterFactory

This works now.
Using general types like Object, Map, or List for the base type is error-prone, but the checks for these cases are not worth the code cost.

* Delete redundant test.

Let's not encourage users to use Object as a base type by showing it in a test.
This commit is contained in:
Eric Cochran
2018-11-18 07:15:41 -08:00
committed by Jesse Wilson
parent 6e6abf54ab
commit 5f0b2ee8e3
2 changed files with 3 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
adapters/src/main/java/com/squareup/moshi/adapters/PolymorphicJsonAdapterFactory.java
View File

@@ -86,8 +86,7 @@ import javax.annotation.CheckReturnValue;
* <p>This class imposes strict requirements on its use:
*
* <ul>
* <li>Base types may be classes or interfaces. You may not use {@code Object.class} as a base
* type.
* <li>Base types may be classes or interfaces.
* <li>Subtypes must encode as JSON objects.
* <li>Type information must be in the encoded object. Each message must have a type label like
* {@code hand_type} whose value is a string like {@code blackjack} that identifies which type
@@ -125,10 +124,6 @@ public final class PolymorphicJsonAdapterFactory<T> implements JsonAdapter.Facto
public static <T> PolymorphicJsonAdapterFactory<T> of(Class<T> baseType, String labelKey) {
if (baseType == null) throw new NullPointerException("baseType == null");
if (labelKey == null) throw new NullPointerException("labelKey == null");
if (baseType == Object.class) {
throw new IllegalArgumentException(
"The base type must not be Object. Consider using a marker interface.");
}
return new PolymorphicJsonAdapterFactory<>(
baseType, labelKey, Collections.<String>emptyList(), Collections.<Type>emptyList());
}
@@ -162,9 +157,7 @@ public final class PolymorphicJsonAdapterFactory<T> implements JsonAdapter.Facto
jsonAdapters.add(moshi.adapter(subtypes.get(i)));
}
JsonAdapter<Object> objectJsonAdapter = moshi.adapter(Object.class);
return new PolymorphicJsonAdapter(
labelKey, labels, subtypes, jsonAdapters, objectJsonAdapter).nullSafe();
return new PolymorphicJsonAdapter(labelKey, labels, subtypes, jsonAdapters).nullSafe();
}
static final class PolymorphicJsonAdapter extends JsonAdapter<Object> {
@@ -172,7 +165,6 @@ public final class PolymorphicJsonAdapterFactory<T> implements JsonAdapter.Facto
final List<String> labels;
final List<Type> subtypes;
final List<JsonAdapter<Object>> jsonAdapters;
final JsonAdapter<Object> objectJsonAdapter;
/** Single-element options containing the label's key only. */
final JsonReader.Options labelKeyOptions;
@@ -180,13 +172,11 @@ public final class PolymorphicJsonAdapterFactory<T> implements JsonAdapter.Facto
final JsonReader.Options labelOptions;
PolymorphicJsonAdapter(String labelKey, List<String> labels,
List<Type> subtypes, List<JsonAdapter<Object>> jsonAdapters,
JsonAdapter<Object> objectJsonAdapter) {
List<Type> subtypes, List<JsonAdapter<Object>> jsonAdapters) {
this.labelKey = labelKey;
this.labels = labels;
this.subtypes = subtypes;
this.jsonAdapters = jsonAdapters;
this.objectJsonAdapter = objectJsonAdapter;
this.labelKeyOptions = JsonReader.Options.of(labelKey);
this.labelOptions = JsonReader.Options.of(labels.toArray(new String[0]));

10
adapters/src/test/java/com/squareup/moshi/adapters/PolymorphicJsonAdapterFactoryTest.java
View File

@@ -170,16 +170,6 @@ public final class PolymorphicJsonAdapterFactoryTest {
assertThat(reader.peek()).isEqualTo(JsonReader.Token.END_DOCUMENT);
}
@Test public void disallowObjectBaseType() {
try {
PolymorphicJsonAdapterFactory.of(Object.class, "type");
fail();
} catch (IllegalArgumentException expected) {
assertThat(expected).hasMessage(
"The base type must not be Object. Consider using a marker interface.");
}
}
/**
* Longs that do not have an exact double representation are problematic for JSON. It is a bad
* idea to use JSON for these values! But Moshi tries to retain long precision where possible.