Uploaded image for project: 'camunda BPM'
  1. camunda BPM
  2. CAM-13651

SpinJsonNode elements method is not documented clear enough

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Fixed
    • Icon: L3 - Default L3 - Default
    • None
    • None
    • spin
    • None

      Acceptance Criteria (Required on creation):

      The JavaDocs for SpinJsonNode.elements() are not clear enough. See https://javadoc.io/doc/org.camunda.spin/camunda-spin-core/1.9.1/org/camunda/spin/json/SpinJsonNode.html#elements--

      public abstract SpinList<SpinJsonNode> elements()
Get this node as list.
Returns:
    the list value of this node

      It is not clear, that elements() returns a list of copies of the SpinJsonNode objects and that modifying the list will not update the original SpinJsonNode. See https://github.com/camunda/camunda-spin/blob/cf898059dd159fa82e58379188ec5bb2c2cbf73c/dataformat-json-jackson/src/main/java/org/camunda/spin/impl/json/jackson/JacksonJsonNode.java#L425

        This is the controller panel for Smart Panels app

            [CAM-13651] SpinJsonNode elements method is not documented clear enough

            Miklas Boskamp added a comment - - edited

            We will not release a new version of Spin for this fix immediately. The fixVersion field in this ticket will remain empty for now. The change will be included in the next release of Spin but today we cannot tell when that will be.

            Miklas Boskamp added a comment - - edited We will not release a new version of Spin for this fix immediately. The fixVersion field in this ticket will remain empty for now. The change will be included in the next release of Spin but today we cannot tell when that will be.

              miklas.boskamp Miklas Boskamp
              miklas.boskamp Miklas Boskamp
              Yana Vasileva Yana Vasileva
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: