AutoValue Extensions

Transcript

1. AutoValue Extensions Gabriel Ittner
2. public class User { public String id; public String name; public String email; }
3. How do we make a value type out of this? public class User { public String id; public String name; public String email; }
4. How do we make a value type out of this? • immutable public class User { public String id; public String name; public String email; }
5. How do we make a value type out of this? • immutable • identityless public class User { public String id; public String name; public String email; }
6. Value type public class User { public final String id; public final String name; public final String email; public User(String id, String name, String email) { this.id = id; this.name = name; this.email = email; } }
7. Value type public class User { private final String id; private final String name; private final String email; public User(String id, String name, String email) { this.id = id; this.name = name; this.email = email; } public String id() { return id; } public String name() { return name; } public String email() { return email; } }
8. Value type public final class User { private final String id; private final String name; private final String email; public User(String id, String name, String email) { this.id = id; this.name = name; this.email = email; } public String id() { return id; } public String name() { return name; } public String email() { return email; } @Override public boolean equals(Object o) { if (this == o) return true; if (o == null || getClass() != o.getClass()) return false; User user = (User) o; if (!id.equals(user.id)) return false; if (!name.equals(user.name)) return false; return email.equals(user.email); } @Override public int hashCode() { int result = id.hashCode(); result = 31 * result + name.hashCode(); result = 31 * result + email.hashCode(); return result; } }
9. Value type public final class User { private final String id; private final String name; private final String email; public User(String id, String name, String email) { this.id = id; this.name = name; this.email = email; } public String id() { return id; } public String name() { return name; } public String email() { return email; } @Override public boolean equals(Object o) { if (this == o) return true; if (o == null || getClass() != o.getClass()) return false; User user = (User) o; if (!id.equals(user.id)) return false; if (!name.equals(user.name)) return false; return email.equals(user.email); } @Override public int hashCode() { int result = id.hashCode(); result = 31 * result + name.hashCode(); result = 31 * result + email.hashCode(); return result; } @Override public String toString() { return "User{" + "id='" + id + '\'' + ", name='" + name + '\'' + ", email='" + email + '\'' + '}'; } }
10. Value type public final class User { private final String id; private final String name; private final String email; public User(String id, String name, String email) { this.id = id; this.name = name; this.email = email; } public String id() { return id; } public String name() { return name; } public String email() { return email; } @Override public boolean equals(Object o) { if (this == o) return true; if (o == null || getClass() != o.getClass()) return false; User user = (User) o; if (!id.equals(user.id)) return false; if (!name.equals(user.name)) return false; return email.equals(user.email); } @Override public int hashCode() { int result = id.hashCode(); result = 31 * result + name.hashCode(); result = 31 * result + email.hashCode(); return result; } @Override public String toString() { return "User{" + "id='" + id + '\'' + ", name='" + name + '\'' + ", email='" + email + '\'' + '}'; } }
11. Value type public final class User { private final String id; private final String name; private final String email; private final String profilePicture; public User(String id, String name, String email, String profilePicture) { this.id = id; this.name = name; this.email = email; this.profilePicture = profilePicture; } public String id() { return id; } public String name() { return name; } public String email() { return email; } public String profilePicture() { return profilePicture; } @Override public boolean equals(Object o) { if (this == o) return true; if (o == null || getClass() != o.getClass()) return false; User user = (User) o; if (!id.equals(user.id)) return false; if (!name.equals(user.name)) return false; if (!email.equals(user.email)) return false; return profilePicture.equals(user.profilePicture); } @Override public int hashCode() { int result = id.hashCode(); result = 31 * result + name.hashCode(); result = 31 * result + email.hashCode(); result = 31 * result + profilePicture.hashCode(); return result; } @Override public String toString() { return "User{" + "id='" + id + '\'' + ", name='" + name + '\'' + ", email='" + email + '\'' + ", profilePicture='" + profilePicture + '\'' + '}'; }
12. AutoValue
13. AutoValue public class User { public String id; public String name; public String email; }
14. AutoValue public abstract class User { public abstract String id(); public abstract String name(); public abstract String email(); }
15. AutoValue @AutoValue public abstract class User { public abstract String id(); public abstract String name(); public abstract String email(); }
16. AutoValue @AutoValue public abstract class User { public abstract String id(); public abstract String name(); public abstract String email(); } @Generated("com.google.auto.value.processor.AutoValueProcessor") final class AutoValue_User extends User { // value type implementation }
17. AutoValue
18. AutoValue • API-invisible
19. AutoValue • API-invisible • handles Nullability
20. AutoValue • API-invisible • handles Nullability • builders with @AutoValue.Builder
21. AutoValue • API-invisible • handles Nullability • builders with @AutoValue.Builder • https://tinyurl.com/auto-value-userguide
22. AutoValue Extensions
23. AutoValue Extensions • AutoParcel - fork to support Parcelable
24. AutoValue Extensions • AutoParcel - fork to support Parcelable • Ryan Harter contributes extension support
25. AutoValue Extensions • AutoParcel - fork to support Parcelable • Ryan Harter contributes extension support • Version 1.2 - provisional support
26. AutoValue Extensions • AutoParcel - fork to support Parcelable • Ryan Harter contributes extension support • Version 1.2 - provisional support • Version 1.3 - stable API
27. auto-value-parcel
28. auto-value-parcel @AutoValue public abstract class User { public abstract String id(); public abstract String name(); public abstract String email(); }
29. auto-value-parcel @AutoValue public abstract class User implements Parcelable { public abstract String id(); public abstract String name(); public abstract String email(); }
30. auto-value-parcel @AutoValue public abstract class User implements Parcelable { public abstract String id(); public abstract String name(); public abstract String email(); } abstract class $AutoValue_User extends User { // value type implementation }
31. auto-value-parcel @AutoValue public abstract class User implements Parcelable { public abstract String id(); public abstract String name(); public abstract String email(); } abstract class $AutoValue_User extends User { // value type implementation } final class AutoValue_User extends $AutoValue_User { // parcelable implementation }
32. auto-value-with
33. auto-value-with @AutoValue public abstract class User { public abstract String id(); public abstract String name(); public abstract String email(); }
34. auto-value-with @AutoValue public abstract class User { public abstract String id(); public abstract String name(); public abstract String email(); public abstract User withEmail(String email); }
35. auto-value-with @AutoValue public abstract class User { public abstract String id(); public abstract String name(); public abstract String email(); public abstract User withEmail(String email); } abstract class $AutoValue_User extends User { ... }
36. auto-value-with @AutoValue public abstract class User { public abstract String id(); public abstract String name(); public abstract String email(); public abstract User withEmail(String email); } abstract class $AutoValue_User extends User { ... } final class AutoValue_User extends $AutoValue_User { public User withEmail(String email) { return new AutoValue_User(id(), name(), email); } }
37. Multiple extensions abstract class $$AutoValue_User extends User { // value type implementation } abstract class $AutoValue_User extends $$AutoValue_User { // with implementation } final class AutoValue_User extends $AutoValue_User { // parcelable implementation }
38. Other extensions • github.com/rharter/ auto-value-parcel • github.com/gabrielittner/ auto-value-with
39. Other extensions • github.com/rharter/ auto-value-parcel • github.com/gabrielittner/ auto-value-with • github.com/gabrielittner/ auto-value-cursor
40. Other extensions • github.com/rharter/ auto-value-parcel • github.com/gabrielittner/ auto-value-with • github.com/gabrielittner/ auto-value-cursor • github.com/rharter/ auto-value-gson
41. Other extensions • github.com/rharter/ auto-value-parcel • github.com/gabrielittner/ auto-value-with • github.com/gabrielittner/ auto-value-cursor • github.com/rharter/ auto-value-gson • github.com/rharter/ auto-value-moshi
42. Other extensions • github.com/rharter/ auto-value-parcel • github.com/gabrielittner/ auto-value-with • github.com/gabrielittner/ auto-value-cursor • github.com/rharter/ auto-value-gson • github.com/rharter/ auto-value-moshi • github.com/square/ auto-value-redacted
43. Other extensions • github.com/rharter/ auto-value-parcel • github.com/gabrielittner/ auto-value-with • github.com/gabrielittner/ auto-value-cursor • github.com/rharter/ auto-value-gson • github.com/rharter/ auto-value-moshi • github.com/square/ auto-value-redacted • github.com/mattlogan/ auto-value-firebase
44. Extension API
45. Extension API public abstract class AutoValueExtension { public boolean applicable(Context context) { } public boolean mustBeFinal(Context context) { } public Set<String> consumeProperties(Context context) { } public Set<ExecutableElement> consumeMethods(Context context) { } public abstract String generateClass(Context context, String className, String classToExtend, boolean isFinal); }
46. Extension API public abstract class AutoValueExtension { public boolean applicable(Context context) { } public boolean mustBeFinal(Context context) { } public Set<String> consumeProperties(Context context) { } public Set<ExecutableElement> consumeMethods(Context context) { } public abstract String generateClass(Context context, String className, String classToExtend, boolean isFinal); }
47. Extension API public interface Context { /* ... */ TypeElement autoValueClass(); Map<String, ExecutableElement> properties(); Set<ExecutableElement> abstractMethods(); }
48. Extension API public interface Context { /* ... */ TypeElement autoValueClass(); Map<String, ExecutableElement> properties(); Set<ExecutableElement> abstractMethods(); }
49. Extension API public interface Context { /* ... */ TypeElement autoValueClass(); Map<String, ExecutableElement> properties(); Set<ExecutableElement> abstractMethods(); }
50. Extension API public interface Context { /* ... */ TypeElement autoValueClass(); Map<String, ExecutableElement> properties(); Set<ExecutableElement> abstractMethods(); }
51. Extension API public abstract class AutoValueExtension { public boolean applicable(Context context) { } public boolean mustBeFinal(Context context) { } public Set<String> consumeProperties(Context context) { } public Set<ExecutableElement> consumeMethods(Context context) { } public abstract String generateClass(Context context, String className, String classToExtend, boolean isFinal); }
52. Extension API public abstract class AutoValueExtension { public boolean applicable(Context context) { } public boolean mustBeFinal(Context context) { } public Set<String> consumeProperties(Context context) { } public Set<ExecutableElement> consumeMethods(Context context) { } public abstract String generateClass(Context context, String className, String classToExtend, boolean isFinal); }
53. Extension API public abstract class AutoValueExtension { public boolean applicable(Context context) { } public boolean mustBeFinal(Context context) { } public Set<String> consumeProperties(Context context) { } public Set<ExecutableElement> consumeMethods(Context context) { } public abstract String generateClass(Context context, String className, String classToExtend, boolean isFinal); }
54. Extension API public boolean applicable(Context context) { }
55. Extension API public boolean applicable(Context context) { return isImplementingParcelable(context.autoValueClass()); }
56. Extension API public boolean applicable(Context context) { return containsWitherMethod(context.abstractMethods()); }
57. Extension API public abstract class AutoValueExtension { public boolean applicable(Context context) { } public boolean mustBeFinal(Context context) { } public Set<String> consumeProperties(Context context) { } public Set<ExecutableElement> consumeMethods(Context context) { } public abstract String generateClass(Context context, String className, String classToExtend, boolean isFinal); }
58. Extension API public abstract class AutoValueExtension { public boolean applicable(Context context) { } public boolean mustBeFinal(Context context) { } public Set<String> consumeProperties(Context context) { } public Set<ExecutableElement> consumeMethods(Context context) { } public abstract String generateClass(Context context, String className, String classToExtend, boolean isFinal); }
59. Extension API public abstract class AutoValueExtension { public boolean applicable(Context context) { } public boolean mustBeFinal(Context context) { } public Set<String> consumeProperties(Context context) { } public Set<ExecutableElement> consumeMethods(Context context) { } public abstract String generateClass(Context context, String className, String classToExtend, boolean isFinal); }
60. Extension API public Set<String> consumeProperties(Context context) { } public Set<ExecutableElement> consumeMethods(Context context) { }
61. Extension API public Set<String> consumeProperties(Context context) { return Collections.singletonSet("describeContents"); } public Set<ExecutableElement> consumeMethods(Context context) { return getWriteToParcelMethod(context.abstractMethods()); }
62. Extension API public Set<String> consumeProperties(Context context) { return Collections.emptySet(); } public Set<ExecutableElement> consumeMethods(Context context) { return getWitherMethods(context.abstractMethods()); }
63. Extension API public abstract class AutoValueExtension { public boolean applicable(Context context) { } public boolean mustBeFinal(Context context) { } public Set<String> consumeProperties(Context context) { } public Set<ExecutableElement> consumeMethods(Context context) { } public abstract String generateClass(Context context, String className, String classToExtend, boolean isFinal); }
64. Extension API public abstract class AutoValueExtension { public boolean applicable(Context context) { } public boolean mustBeFinal(Context context) { } public Set<String> consumeProperties(Context context) { } public Set<ExecutableElement> consumeMethods(Context context) { } public abstract String generateClass(Context context, String className, String classToExtend, boolean isFinal); }
65. Extension API public abstract class AutoValueExtension { public boolean applicable(Context context) { } public boolean mustBeFinal(Context context) { } public Set<String> consumeProperties(Context context) { } public Set<ExecutableElement> consumeMethods(Context context) { } public abstract String generateClass(Context context, String className, String classToExtend, boolean isFinal); }
66. Helpful tools
67. Helpful tools • JavaPoet
68. Helpful tools • JavaPoet • auto-value-extension-utils
69. Helpful tools • JavaPoet • auto-value-extension-utils • AutoCommon
70. Helpful tools • JavaPoet • auto-value-extension-utils • AutoCommon • AutoService
71. Helpful tools META-INF/services/com.google.auto.value.extension.AutoValueExtension
72. Helpful tools META-INF/services/com.google.auto.value.extension.AutoValueExtension com.example.MyExtension
73. Helpful tools META-INF/services/com.google.auto.value.extension.AutoValueExtension com.example.MyExtension @AutoService(AutoValueExtension.class) public class MyExtension extends AutoValueExtension { /* ... */ }
74. Helpful tools • JavaPoet • auto-value-extension-utils • AutoCommon • AutoService
75. Helpful tools • JavaPoet • auto-value-extension-utils • AutoCommon • AutoService • Truth + compile-testing
76. Thanks twitter.com/gabrielittner github.com/gabrielittner