5:12 p.m.
Author: julien(a)jboss.com
Date: 2007-03-14 12:12:13 -0400 (Wed, 14 Mar 2007)
New Revision: 6668
Added:
trunk/common/src/main/org/jboss/portal/common/util/IteratorStatus.java
trunk/common/src/main/org/jboss/portal/test/common/IteratorStatusTestCase.java
Modified:
trunk/common/build.xml
trunk/common/src/main/org/jboss/portal/common/reflect/Modifier.java
trunk/common/src/main/org/jboss/portal/test/common/ModifierTestCase.java
Log:
added an IteratorStatus class which helps to keep the index of the latest obtained value
from an iterator
Modified: trunk/common/build.xml
===================================================================
--- trunk/common/build.xml 2007-03-14 14:32:08 UTC (rev 6667)
+++ trunk/common/build.xml 2007-03-14 16:12:13 UTC (rev 6668)
@@ -232,6 +232,7 @@
<test todir="${test.reports}"
name="org.jboss.portal.test.common.URLToolsTestCase"/>
<test todir="${test.reports}"
name="org.jboss.portal.test.common.ToolsTestCase"/>
<test todir="${test.reports}"
name="org.jboss.portal.test.common.ModifierTestCase"/>
+ <test todir="${test.reports}"
name="org.jboss.portal.test.common.IteratorStatusTestCase"/>
</x-test>
<x-classpath>
<pathelement location="${build.classes}"/>
Modified: trunk/common/src/main/org/jboss/portal/common/reflect/Modifier.java
===================================================================
--- trunk/common/src/main/org/jboss/portal/common/reflect/Modifier.java 2007-03-14
14:32:08 UTC (rev 6667)
+++ trunk/common/src/main/org/jboss/portal/common/reflect/Modifier.java 2007-03-14
16:12:13 UTC (rev 6668)
@@ -25,13 +25,23 @@
import java.lang.reflect.Field;
/**
+ * Extends the java Modifier object in order to add more utility methods.
+ *
* @author <a href="mailto:julien@jboss.org">Julien Viet</a>
* @version $Revision: 1.1 $
*/
public class Modifier extends java.lang.reflect.Modifier
{
- public static boolean isReadableProperty(Field f)
+ /**
+ * Return true if the field is considered as a readable property which means that
+ * it is public and non static.
+ *
+ * @param f the field to test
+ * @return true if the field is a readable property
+ * @throws IllegalArgumentException if the field argument is null
+ */
+ public static boolean isReadableProperty(Field f) throws IllegalArgumentException
{
if (f == null)
{
@@ -43,6 +53,14 @@
return (modifiers & STATIC) == 0 && (modifiers & PUBLIC) != 0;
}
+ /**
+ * Return true if the field is considered as a writable property which means that
+ * it is public, non static and non final.
+ *
+ * @param f the field to test
+ * @return true if the field is a writable property
+ * @throws IllegalArgumentException if the field argument is null
+ */
public static boolean isWritableProperty(Field f)
{
if (f == null)
Added: trunk/common/src/main/org/jboss/portal/common/util/IteratorStatus.java
===================================================================
--- trunk/common/src/main/org/jboss/portal/common/util/IteratorStatus.java
(rev 0)
+++ trunk/common/src/main/org/jboss/portal/common/util/IteratorStatus.java 2007-03-14
16:12:13 UTC (rev 6668)
@@ -0,0 +1,101 @@
+/******************************************************************************
+ * JBoss, a division of Red Hat *
+ * Copyright 2006, Red Hat Middleware, LLC, and individual *
+ * contributors as indicated by the @authors tag. See the *
+ * copyright.txt in the distribution for a full listing of *
+ * individual contributors. *
+ * *
+ * This is free software; you can redistribute it and/or modify it *
+ * under the terms of the GNU Lesser General Public License as *
+ * published by the Free Software Foundation; either version 2.1 of *
+ * the License, or (at your option) any later version. *
+ * *
+ * This software is distributed in the hope that it will be useful, *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
+ * Lesser General Public License for more details. *
+ * *
+ * You should have received a copy of the GNU Lesser General Public *
+ * License along with this software; if not, write to the Free *
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA *
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org. *
+ ******************************************************************************/
+package org.jboss.portal.common.util;
+
+import java.util.Iterator;
+import java.util.Collection;
+
+/**
+ * An java.util.Iterator wrapper which keep additional state associated with the wrapped
iterator.
+ * The implementation of the Iterator interface delegates all operations to the wrapped
iterator.
+ *
+ * @author <a href="mailto:julien@jboss.org">Julien Viet</a>
+ * @version $Revision: 1.1 $
+ */
+public class IteratorStatus implements Iterator
+{
+
+ /** The real iterator. */
+ private final Iterator delegate;
+
+ /** The iterator index. */
+ private int index;
+
+ /**
+ * @param delegate the wrapped iterator
+ * @throws IllegalArgumentException if the wrapped iterator is null
+ */
+ public IteratorStatus(Iterator delegate) throws IllegalArgumentException
+ {
+ if (delegate == null)
+ {
+ throw new IllegalArgumentException("No iterator is provided");
+ }
+ this.delegate = delegate;
+ this.index = -1;
+ }
+
+ /**
+ * @param c the collection to iterate
+ * @throws IllegalArgumentException if the collection is null
+ */
+ public IteratorStatus(Collection c) throws IllegalArgumentException
+ {
+ if (c == null)
+ {
+ throw new IllegalArgumentException("No collection is provided");
+ }
+ this.delegate = c.iterator();
+ this.index = -1;
+ }
+
+ /**
+ * Returns the index of the last element obtained or -1 if no element has been
returned yet.
+ *
+ * @return the index of the last element obtained
+ */
+ public int getElementIndex()
+ {
+ return index;
+ }
+
+ public boolean hasNext()
+ {
+ return delegate.hasNext();
+ }
+
+ public Object next()
+ {
+ Object o = delegate.next();
+
+ // Increment after getting the next object since the call to the next() method
+ // can throw a NoSuchElementException
+ index++;
+ return o;
+ }
+
+ public void remove()
+ {
+ delegate.remove();
+ }
+}
Added: trunk/common/src/main/org/jboss/portal/test/common/IteratorStatusTestCase.java
===================================================================
--- trunk/common/src/main/org/jboss/portal/test/common/IteratorStatusTestCase.java
(rev 0)
+++
trunk/common/src/main/org/jboss/portal/test/common/IteratorStatusTestCase.java 2007-03-14
16:12:13 UTC (rev 6668)
@@ -0,0 +1,83 @@
+/******************************************************************************
+ * JBoss, a division of Red Hat *
+ * Copyright 2006, Red Hat Middleware, LLC, and individual *
+ * contributors as indicated by the @authors tag. See the *
+ * copyright.txt in the distribution for a full listing of *
+ * individual contributors. *
+ * *
+ * This is free software; you can redistribute it and/or modify it *
+ * under the terms of the GNU Lesser General Public License as *
+ * published by the Free Software Foundation; either version 2.1 of *
+ * the License, or (at your option) any later version. *
+ * *
+ * This software is distributed in the hope that it will be useful, *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
+ * Lesser General Public License for more details. *
+ * *
+ * You should have received a copy of the GNU Lesser General Public *
+ * License along with this software; if not, write to the Free *
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA *
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org. *
+ ******************************************************************************/
+package org.jboss.portal.test.common;
+
+import junit.framework.TestCase;
+
+import java.util.ArrayList;
+import java.util.NoSuchElementException;
+
+import org.jboss.portal.common.util.IteratorStatus;
+
+/**
+ * @author <a href="mailto:julien@jboss.org">Julien Viet</a>
+ * @version $Revision: 1.1 $
+ */
+public class IteratorStatusTestCase extends TestCase
+{
+
+ public void testA()
+ {
+ ArrayList list = new ArrayList();
+ list.add("a");
+ list.add("b");
+ list.add("c");
+
+ //
+ test(new IteratorStatus(list));
+ test(new IteratorStatus(list.iterator()));
+ }
+
+ private void test(IteratorStatus iterator)
+ {
+ assertTrue(iterator.hasNext());
+ assertEquals(-1, iterator.getElementIndex());
+
+ //
+ assertEquals("a", iterator.next());
+ assertTrue(iterator.hasNext());
+ assertEquals(0, iterator.getElementIndex());
+
+ //
+ assertEquals("b", iterator.next());
+ assertTrue(iterator.hasNext());
+ assertEquals(1, iterator.getElementIndex());
+
+ //
+ assertEquals("c", iterator.next());
+ assertFalse(iterator.hasNext());
+ assertEquals(2, iterator.getElementIndex());
+
+ //
+ try
+ {
+ iterator.next();
+ fail("Was expecting a NoSuchElementException");
+ }
+ catch (NoSuchElementException expected)
+ {
+ }
+ assertFalse(iterator.hasNext());
+ assertEquals(2, iterator.getElementIndex());
+ }
+}
Modified: trunk/common/src/main/org/jboss/portal/test/common/ModifierTestCase.java
===================================================================
--- trunk/common/src/main/org/jboss/portal/test/common/ModifierTestCase.java 2007-03-14
14:32:08 UTC (rev 6667)
+++ trunk/common/src/main/org/jboss/portal/test/common/ModifierTestCase.java 2007-03-14
16:12:13 UTC (rev 6668)
@@ -34,6 +34,15 @@
public void testIsReadableProperty() throws Exception
{
+ try
+ {
+ Modifier.isReadableProperty(null);
+ fail("Was expecting an IAE");
+ }
+ catch (IllegalArgumentException expected)
+ {
+ }
+
assertTrue(Modifier.isReadableProperty(Bean.class.getDeclaredField("publicField")));
assertFalse(Modifier.isReadableProperty(Bean.class.getDeclaredField("privateField")));
assertFalse(Modifier.isReadableProperty(Bean.class.getDeclaredField("protectedField")));
@@ -57,6 +66,15 @@
public void testIsWritableProperty() throws Exception
{
+ try
+ {
+ Modifier.isWritableProperty(null);
+ fail("Was expecting an IAE");
+ }
+ catch (IllegalArgumentException expected)
+ {
+ }
+
assertTrue(Modifier.isWritableProperty(Bean.class.getDeclaredField("publicField")));
assertFalse(Modifier.isWritableProperty(Bean.class.getDeclaredField("privateField")));
assertFalse(Modifier.isWritableProperty(Bean.class.getDeclaredField("protectedField")));