Author: hlship
Date: Tue Jan 4 19:26:19 2011
New Revision: 1055146
URL: http://svn.apache.org/viewvc?rev=1055146&view=rev
Log:
TAP5-1390: Improve some of the documentation about Flows and ZippedFlows
Modified:
tapestry/tapestry5/trunk/tapestry-func/src/main/java/org/apache/tapestry5/func/Flow.java
tapestry/tapestry5/trunk/tapestry-func/src/main/java/org/apache/tapestry5/func/ZippedFlow.java
Modified:
tapestry/tapestry5/trunk/tapestry-func/src/main/java/org/apache/tapestry5/func/Flow.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-func/src/main/java/org/apache/tapestry5/func/Flow.java?rev=1055146&r1=1055145&r2=1055146&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-func/src/main/java/org/apache/tapestry5/func/Flow.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-func/src/main/java/org/apache/tapestry5/func/Flow.java
Tue Jan 4 19:26:19 2011
@@ -86,14 +86,16 @@ public interface Flow<T> extends FlowOpe
/**
* Zips this Flow together with another flow to form a Flow of {...@link
Tuple}s. The resulting
- * flow is the length of the shorter of the two input flows.
+ * flow is the length of the shorter of the two input flows. Zipping flows
together is a lazy
+ * operation.
* <p>
* The elements of this flow become the {...@linkplain Tuple#first} value
in each Tuple, the
* elements of the other flow become the {...@linkplain Tuple#second}
value in each Tuple.
*
- * @param <B>
+ * @param <X>
+ * type of element stored in the other flow
* @param otherFlow
- * contains values to match with values in this flow
+ * contains elements to match with elements in this flow
* @return flow of tuples combining values from this flow with values form
the other flow
* @since 5.3.0
*/
Modified:
tapestry/tapestry5/trunk/tapestry-func/src/main/java/org/apache/tapestry5/func/ZippedFlow.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-func/src/main/java/org/apache/tapestry5/func/ZippedFlow.java?rev=1055146&r1=1055145&r2=1055146&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-func/src/main/java/org/apache/tapestry5/func/ZippedFlow.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-func/src/main/java/org/apache/tapestry5/func/ZippedFlow.java
Tue Jan 4 19:26:19 2011
@@ -27,25 +27,28 @@ public interface ZippedFlow<A, B> extend
{
/**
* Mapping for zipped flows; a mapper is used to map tuples of this zipped
flow into new tuples
- * with a new type, forming the resulting zipped flow.
+ * with a new type, forming the resulting zipped flow. This is a lazy
operation.
*/
<X, Y> ZippedFlow<X, Y> mapTuples(Mapper<Tuple<A, B>, Tuple<X, Y>> mapper);
/**
* A ZippedFlow is a Flow of Tuples; this inverts that, splitting each
Tuple into
- * a Flow of values, then assembling the result as a Tuple of two values.
+ * a Flow of elements, then assembling the result as a Tuple of two
values. This is a lazy
+ * operation.
*
* @return two flows of unzipped Tuples
*/
Tuple<Flow<A>, Flow<B>> unzip();
/**
- * Returns a flow of the first values of the tuples of the zipped flow.
+ * Returns a flow of the first values of the tuples of the zipped flow.
This is a lazy
+ * operation.
*/
Flow<A> firsts();
/**
- * Returns a flow of the second values of the tuples of the zipped flow.
+ * Returns a flow of the second values of the tuples of the zipped flow.
This is a lazy
+ * operation.
*/
Flow<B> seconds();
}
