improve docs

lightsail-network · Aug 13, 2023 · f4213a1 · f4213a1
1 parent 27134f5
commit f4213a1
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/src/main/java/org/stellar/sdk/SorobanDataBuilder.java b/src/main/java/org/stellar/sdk/SorobanDataBuilder.java
@@ -110,8 +110,8 @@ public SorobanDataBuilder setResources(
    * SorobanDataBuilder#setReadOnly(Collection)} and {@link
    * SorobanDataBuilder#setReadWrite(Collection)}.
    *
-   * <p>Passing {@code null} to either parameter will IGNORE the existing values. If you want to
-   * clear them, pass empty collection instead.
+   * <p>Passing {@code null} to either parameter will leave that portion of the footprint untouched.
+   * If you want to clear a portion of the footprint, pass an empty collection.
    *
    * @param readOnly the set of ledger keys to set in the read-only portion of the transaction's
    *     sorobanData
@@ -133,6 +133,9 @@ public SorobanDataBuilder setFootprint(
   /**
    * Sets the read-only portion of the storage access footprint to be a certain set of ledger keys.
    *
+   * <p>Passing {@code null} will leave that portion of the footprint untouched. If you want to
+   * clear a portion of the footprint, pass an empty collection.
+   *
    * @param readOnly the set of ledger keys to set in the read-only portion of the transaction's
    *     sorobanData
    * @return this builder instance
@@ -147,6 +150,9 @@ public SorobanDataBuilder setReadOnly(@Nullable Collection<LedgerKey> readOnly)
   /**
    * Sets the read-write portion of the storage access footprint to be a certain set of ledger keys.
    *
+   * <p>Passing {@code null} will leave that portion of the footprint untouched. If you want to
+   * clear a portion of the footprint, pass an empty collection.
+   *
    * @param readWrite the set of ledger keys to set in the read-write portion of the transaction's
    *     sorobanData
    * @return this builder instance