Uploaded image for project: 'Apache Avro'
  1. Apache Avro
  2. AVRO-2253

Documentation of java-class -related annotations

    XMLWordPrintableJSON

    Details

    • Type: Bug
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: java, spec
    • Labels:
      None

      Description

      There is a lack of consistency in the documentation about the use of @java-class (plus, its relation with avro.java.string), @java-element-class and @java-key-class annotations
      For instance, see the references to `@java-element-class`, and the mentions to the same annotation and to `ELEMENT_PROP` as well (in the different classes where constants with that name appear).
      In some places, documentation talks about @java-element instead of @java-element-class
      Even the test case that is supposed to be provided as an example of use of @java-element-class indeed employs @java-class :
      `map<@java-class("java.math.BigDecimal") string> mapWithBigDecimalElements`
      is equivalent to
      `@java-element-classmap("java.math.BigDecimal") <string> mapWithBigDecimalElements`
      but it is not clear from the documentation

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              samuelm Samuel Martin
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: