[midPoint-git] [Evolveum/prism] 08c475: Improve documentation of delta builder

[Andrej]

  Branch: refs/heads/midpilot
  Home:   https://github.com/Evolveum/prism
  Commit: 08c4758326b5aa142d3481052809ecbffb34c4f1
      https://github.com/Evolveum/prism/commit/08c4758326b5aa142d3481052809ecbffb34c4f1
  Author: Andrej Zan <andrej.zan at evolveum.com>
  Date:   2025-11-28 (Fri, 28 Nov 2025)

  Changed paths:
    M infra/prism-api/src/main/java/com/evolveum/midpoint/prism/delta/builder/S_ItemEntry.java

  Log Message:
  -----------
  Improve documentation of delta builder

**What**

Add an important note to one of the delta builder interfaces, about its
potential immutability.

**Why**

Currently the only implementation of this interface is `DeltaBuilder`
class, which implements affected methods in an "immutable" way, meaning
that they does not return the same instance of the builder, but creates
a new one.

That is however a bit confusing, because other methods does not behave
like this. If the returned instance is not correctly reassigned to the
initial variable, it can cause bugs where not all added items will be
present in built delta.

The docs uses the word "potential", because I do not want to add
behavior as a constraint to other implementers.



To unsubscribe from these emails, change your notification settings at https://github.com/Evolveum/prism/settings/notifications