[JENKINS-33467] Clarifying that CauseAction.getCauses is immutable an…

…d you should construct the action with the causes you want. (cherry picked from commit 4adee75)
jenkinsci · Apr 25, 2016 · 63886be · amuniz · Jul 6, 2016 · oleg-nenashev
1 parent 916e759
commit 63886be
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/core/src/main/java/hudson/model/CauseAction.java b/core/src/main/java/hudson/model/CauseAction.java
@@ -82,14 +82,21 @@ public CauseAction(Collection<? extends Cause> causes) {
    	public CauseAction(CauseAction ca) {
    		addCauses(ca.getCauses());
    	}
-
+
+    /**
+     * Lists all causes of this build.
+     * Note that the current implementation does not preserve insertion order of duplicates.
+     * @return an immutable list;
+     *         to create an action with multiple causes use either of the constructors that support this;
+     *         to append causes retroactively to a build you must create a new {@link CauseAction} and replace the old
+     */
 	@Exported(visibility=2)
 	public List<Cause> getCauses() {
 		List<Cause> r = new ArrayList<>();
         for (Map.Entry<Cause,Integer> entry : causeBag.entrySet()) {
             r.addAll(Collections.nCopies(entry.getValue(), entry.getKey()));
         }
-        return r;
+        return Collections.unmodifiableList(r);
 	}
 
     /**