[Documentation] Missing documentation on the enum parsing feature

Offen
#1,484 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
1/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
35/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Veraltet
Tech-Stack
java
Bereich
documentation

Rechercherichtung

Beginne mit der im Issue verlinkten Developer's Guide JSON-Seite und lies anschließend in FieldInfo.java rund um die referenzierte Zeile, um das Parsing-Verhalten von Enums sowie die Annotationen @Value und @NullValue zu verstehen. Fertig ist die Aufgabe, wenn die JSON-Dokumentation einen klaren Absatz enthält, der erklärt, wie Enum-Typen mithilfe dieser Annotationen als @Key-Felder konfiguriert werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

priority: p3 type: feature request

I'm a google-http-client-jackson2 user, and I struggled a bit looking for a way to setup an enum type as a @Key.

This is the exception I was getting: IllegalArgumentException: given enum name New not part of enumeration

Eventually I was able to find that out myself by looking into the class FieldInfo, and I learned of the existence of the annotations @Value and @NullValue.

I'm opening this issue to please ask you to update the Developer's Guide (the JSON page in particular) with a new paragraph talking about those two annotations.

Thanks.

PS: I think this relates to #127

Vorherrschende Sprache
Java
Sterne
1.4k
Forks
476
Ø Merge
10 Std. 47 Min.
Gemergte PRs (30 T.)
3

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus googleapis/google-http-java-client

Alle Issues in googleapis/google-http-java-client

Ähnliche Issues

Weitere Issues zu Java

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.