From d16f84288740404034dac663df339ad647cb6f69 Mon Sep 17 00:00:00 2001
From: Thomas Neidhart <tn@apache.org>
Date: Tue, 7 May 2013 05:19:57 +0000
Subject: [PATCH] Document the reason chainedIterator(Iterator, Iterator) still
 remains.

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/collections/trunk@1479761 13f79535-47bb-0310-9956-ffa450edef68
---
 .../java/org/apache/commons/collections4/IteratorUtils.java     | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/main/java/org/apache/commons/collections4/IteratorUtils.java b/src/main/java/org/apache/commons/collections4/IteratorUtils.java
index ad0d216bf..75d321020 100644
--- a/src/main/java/org/apache/commons/collections4/IteratorUtils.java
+++ b/src/main/java/org/apache/commons/collections4/IteratorUtils.java
@@ -485,6 +485,8 @@ public class IteratorUtils {
      */
     public static <E> Iterator<E> chainedIterator(final Iterator<? extends E> iterator1,
                                                   final Iterator<? extends E> iterator2) {
+        // keep a version with two iterators to avoid the following warning in client code (Java 5 & 6)
+        // "A generic array of E is created for a varargs parameter"
         return new IteratorChain<E>(iterator1, iterator2);
     }