Permalink
Browse files

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.
  • Loading branch information...
1 parent fe53b71 commit 2232d0a7a987812f00e55711b10a3b8fcb3f7e3f @gabrielreid gabrielreid committed Jul 2, 2012
Showing with 4 additions and 0 deletions.
  1. +4 −0 src/main/java/com/cloudera/crunch/PTable.java
@@ -121,6 +121,10 @@
/**
* 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();

0 comments on commit 2232d0a

Please sign in to comment.