[Documentation] Missing documentation on the enum parsing feature

Ouverte
#1,484 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
1/5
Temps estimé
1-3 heures
Accessibilité débutants
35/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
À l'abandon
Stack technique
java
Domaine
documentation

Piste de recherche

Commencez par la page JSON du Developer's Guide liée dans l'issue, puis lisez FieldInfo.java autour de la ligne référencée afin de comprendre le comportement d'analyse des enums ainsi que les annotations @Value et @NullValue. Le travail est terminé lorsque la documentation JSON contient un paragraphe clair expliquant comment configurer des types enum comme champs @Key à l'aide de ces annotations.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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

Langage dominant
Java
Étoiles
1.4k
Forks
476
Merge moyen
10 h 47 min
PR mergées (30 j)
3

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de googleapis/google-http-java-client

Toutes les issues de googleapis/google-http-java-client

Issues similaires

Plus d'issues Java

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.