[Documentation] Missing documentation on the enum parsing feature

未关闭
#1,484 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
1/5
预计耗时
1-3 小时
新手友好度
35/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
停滞
技术栈
java
领域
documentation

调研方向

先从 issue 中链接的 Developer's Guide JSON 页面开始,然后阅读参考行附近的 FieldInfo.java,以了解 enum 的解析行为以及 @Value 和 @NullValue 注解。完成的标准是 JSON 文档包含一个清晰的段落,说明如何使用这些注解将 enum 类型配置为 @Key 字段。

由索引模型根据 Issue 内容生成。

描述

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

主要语言
Java
星标
1.4k
派生
476
平均合并
10 小时 47 分钟
30 天内合并 PR
3

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

googleapis/google-http-java-client 的其他 Issue

查看 googleapis/google-http-java-client 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。