[freenet-cvs] r13818 - trunk/freenet/src/freenet/support

[sb...@freenetproject.org]

Author: sback
Date: 2007-06-28 21:05:30 +0000 (Thu, 28 Jun 2007)
New Revision: 13818

Modified:
   trunk/freenet/src/freenet/support/SimpleFieldSet.java
Log:
Explanation comment added for the KeyIterator subclass

Modified: trunk/freenet/src/freenet/support/SimpleFieldSet.java
===================================================================
--- trunk/freenet/src/freenet/support/SimpleFieldSet.java       2007-06-28 
21:03:49 UTC (rev 13817)
+++ trunk/freenet/src/freenet/support/SimpleFieldSet.java       2007-06-28 
21:05:30 UTC (rev 13818)
@@ -471,6 +471,15 @@
        KeyIterator subIterator;
        String prefix;

+       /**
+        * It provides an iterator for the SimpleSetField
+        * which passes through every key.
+        * (e.g. for key1=value1 key2.sub2=value2 key1.sub=value3
+        * it will provide key1,key2.sub2,key1.sub)
+        * @param a prefix to put BEFORE every key
+        * (e.g. for key1=value, if the iterator is created with prefix 
"aPrefix",
+        * it will provide aPrefixkey1
+        */
        public KeyIterator(String prefix) {
                synchronized(SimpleFieldSet.this) {
                        valuesIterator = values.keySet().iterator();