You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@velocity.apache.org by dl...@apache.org on 2004/05/05 23:17:35 UTC
cvs commit: jakarta-velocity-tools/src/java/org/apache/velocity/tools/generic AlternatorTool.java
dlr 2004/05/05 14:17:35
Modified: src/java/org/apache/velocity/tools/generic
AlternatorTool.java
Log:
* src/java/org/apache/velocity/tools/generic/Alternator.java
Added @return JavaDoc where appropriate.
make(boolean, Object[]), make(boolean, Object, Object): Leveraged
new Alternator ctor which takes an Object[] instead of
java.util.List. For the latter, assured that both arguments are
non-null (and added JavaDoc saying as much).
Revision Changes Path
1.2 +26 -6 jakarta-velocity-tools/src/java/org/apache/velocity/tools/generic/AlternatorTool.java
Index: AlternatorTool.java
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/src/java/org/apache/velocity/tools/generic/AlternatorTool.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -u -r1.1 -r1.2
--- AlternatorTool.java 4 May 2004 03:32:22 -0000 1.1
+++ AlternatorTool.java 5 May 2004 21:17:35 -0000 1.2
@@ -66,6 +66,9 @@
/**
* Make an {@link Alternator} from a List.
+ *
+ * @return The new Alternator, or <code>null</code> if arguments
+ * were illegal.
*/
public Alternator make(boolean auto, List list)
{
@@ -88,6 +91,9 @@
/**
* Make an {@link Alternator} from the values
* in the specified collection.
+ *
+ * @return The new Alternator, or <code>null</code> if arguments
+ * were illegal.
*/
public Alternator make(boolean auto, Collection collection)
{
@@ -108,6 +114,9 @@
/**
* Make an {@link Alternator} from an object array.
+ *
+ * @return The new Alternator, or <code>null</code> if arguments
+ * were illegal.
*/
public Alternator make(boolean auto, Object[] array)
{
@@ -115,12 +124,15 @@
{
return null;
}
- return make(auto, Arrays.asList(array));
+ return new Alternator(auto, array);
}
/**
* Make a non-automatic {@link Alternator} from a list containing the two
* specified objects.
+ *
+ * @return The new Alternator, or <code>null</code> if arguments
+ * were illegal.
*/
public Alternator make(Object o1, Object o2)
{
@@ -130,13 +142,21 @@
/**
* Make an {@link Alternator} from a list containing the two
* specified objects.
+ *
+ * @param o1 The first of two objects for alternation between.
+ * Must be non-<code>null</code>.
+ * @param o2 The second of two objects for alternation between.
+ * Must be non-<code>null</code>.
+ * @return The new Alternator, or <code>null</code> if arguments
+ * were illegal.
*/
public Alternator make(boolean auto, Object o1, Object o2)
{
- List list = new ArrayList();
- list.add(o1);
- list.add(o2);
- return make(auto, list);
+ if (o1 == null || o2 == null)
+ {
+ return null;
+ }
+ return new Alternator(auto, new Object[] { o1, o2 });
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: velocity-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: velocity-dev-help@jakarta.apache.org