incubator-crunch-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From gr...@apache.org
Subject git commit: Improve documentation of PTable#materializeToMap
Date Mon, 02 Jul 2012 09:47:04 GMT
Updated Branches:
  refs/heads/master fe53b71fe -> 2232d0a7a


Improve documentation of PTable#materializeToMap

The PTable#materializeToMap method returns a Map, while a PTable
is actually a multi-map (i.e. possibly multiple values for a
single key). The documentation of this method has been updated
to clarify this.


Project: http://git-wip-us.apache.org/repos/asf/incubator-crunch/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-crunch/commit/2232d0a7
Tree: http://git-wip-us.apache.org/repos/asf/incubator-crunch/tree/2232d0a7
Diff: http://git-wip-us.apache.org/repos/asf/incubator-crunch/diff/2232d0a7

Branch: refs/heads/master
Commit: 2232d0a7a987812f00e55711b10a3b8fcb3f7e3f
Parents: fe53b71
Author: Gabriel Reid <gabriel.reid@gmail.com>
Authored: Mon Jul 2 11:44:21 2012 +0200
Committer: Gabriel Reid <gabriel.reid@gmail.com>
Committed: Mon Jul 2 11:44:21 2012 +0200

----------------------------------------------------------------------
 src/main/java/com/cloudera/crunch/PTable.java |    4 ++++
 1 files changed, 4 insertions(+), 0 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-crunch/blob/2232d0a7/src/main/java/com/cloudera/crunch/PTable.java
----------------------------------------------------------------------
diff --git a/src/main/java/com/cloudera/crunch/PTable.java b/src/main/java/com/cloudera/crunch/PTable.java
index 04b45af..b622a3f 100644
--- a/src/main/java/com/cloudera/crunch/PTable.java
+++ b/src/main/java/com/cloudera/crunch/PTable.java
@@ -121,6 +121,10 @@ public interface PTable<K, V> extends PCollection<Pair<K,
V>> {
   
   /**
    * Returns a Map<K, V> made up of the keys and values in this PTable.
+   * <p>
+   * <b>Note:</b> The contents of the returned map may not be exactly the same
+   * as this PTable, as a PTable is a multi-map (i.e. can contain multiple
+   * values for a single key).
    */
   Map<K, V> materializeToMap();
 


Mime
View raw message