Permalink
Browse files

Javadoc tweaks to get rid of warnings.

  • Loading branch information...
lintool committed Mar 29, 2017
1 parent 12006bd commit 27e19a4f3f8d6b2d27cdfab45a08c848e0871224
Showing with 86 additions and 10 deletions.
  1. +5 −3 src/main/java/io/bespin/java/mapreduce/bfs/BfsNode.java
  2. +4 −1 src/main/java/io/bespin/java/mapreduce/bfs/EncodeBfsGraph.java
  3. +4 −1 src/main/java/io/bespin/java/mapreduce/bfs/FindNodeAtDistance.java
  4. +4 −1 src/main/java/io/bespin/java/mapreduce/bfs/FindReachableNodes.java
  5. +4 −1 src/main/java/io/bespin/java/mapreduce/bfs/IterateBfs.java
  6. +3 −0 src/main/java/io/bespin/java/mapreduce/bigram/BigramCount.java
  7. +3 −0 src/main/java/io/bespin/java/mapreduce/bigram/ComputeBigramRelativeFrequencyPairs.java
  8. +3 −0 src/main/java/io/bespin/java/mapreduce/bigram/ComputeBigramRelativeFrequencyStripes.java
  9. +3 −0 src/main/java/io/bespin/java/mapreduce/cooccur/ComputeCooccurrenceMatrixPairs.java
  10. +3 −0 src/main/java/io/bespin/java/mapreduce/cooccur/ComputeCooccurrenceMatrixStripes.java
  11. +3 −0 src/main/java/io/bespin/java/mapreduce/mean/ComputeMeanV1.java
  12. +3 −0 src/main/java/io/bespin/java/mapreduce/mean/ComputeMeanV2.java
  13. +3 −0 src/main/java/io/bespin/java/mapreduce/mean/ComputeMeanV3.java
  14. +3 −0 src/main/java/io/bespin/java/mapreduce/mean/ComputeMeanV4.java
  15. +3 −0 src/main/java/io/bespin/java/mapreduce/mean/GenerateRandomData.java
  16. +3 −0 src/main/java/io/bespin/java/mapreduce/pagerank/BuildPageRankRecords.java
  17. +3 −0 src/main/java/io/bespin/java/mapreduce/pagerank/DumpPageRankRecordsToPlainText.java
  18. +3 −0 src/main/java/io/bespin/java/mapreduce/pagerank/FindMaxPageRankNodes.java
  19. +5 −3 src/main/java/io/bespin/java/mapreduce/pagerank/PageRankNode.java
  20. +3 −0 src/main/java/io/bespin/java/mapreduce/pagerank/RunPageRankBasic.java
  21. +3 −0 src/main/java/io/bespin/java/mapreduce/pagerank/RunPageRankSchimmy.java
  22. +3 −0 src/main/java/io/bespin/java/mapreduce/search/BooleanRetrieval.java
  23. +3 −0 src/main/java/io/bespin/java/mapreduce/search/BuildInvertedIndex.java
  24. +3 −0 src/main/java/io/bespin/java/mapreduce/wordcount/HBaseWordCount.java
  25. +3 −0 src/main/java/io/bespin/java/mapreduce/wordcount/HBaseWordCountFetch.java
  26. +3 −0 src/main/java/io/bespin/java/mapreduce/wordcount/WordCount.java
@@ -90,6 +90,7 @@ public void setType(Type type) {
* Deserializes this object.
*
* @param in source for raw byte representation
+ * @throws IOException if any exception is encountered during object deserialization
*/
@Override
public void readFields(DataInput in) throws IOException {
@@ -114,6 +115,7 @@ public void readFields(DataInput in) throws IOException {
* Serializes this object.
*
* @param out where to write the raw byte representation
+ * @throws IOException if any exception is encountered during object serialization
*/
@Override
public void write(DataOutput out) throws IOException {
@@ -142,7 +144,7 @@ public String toString() {
* Returns the serialized representation of this object as a byte array.
*
* @return byte array representing the serialized representation of this object
- * @throws IOException
+ * @throws IOException if any exception is encountered during object serialization
*/
public byte[] serialize() throws IOException {
ByteArrayOutputStream bytesOut = new ByteArrayOutputStream();
@@ -157,7 +159,7 @@ public String toString() {
*
* @param in source for reading the serialized representation
* @return newly-created object
- * @throws IOException
+ * @throws IOException if any exception is encountered during object deserialization
*/
public static BfsNode create(DataInput in) throws IOException {
BfsNode m = new BfsNode();
@@ -171,7 +173,7 @@ public static BfsNode create(DataInput in) throws IOException {
*
* @param bytes raw serialized representation
* @return newly-created object
- * @throws IOException
+ * @throws IOException if any exception is encountered during object deserialization
*/
public static BfsNode create(byte[] bytes) throws IOException {
return create(new DataInputStream(new ByteArrayInputStream(bytes)));
@@ -157,7 +157,10 @@ public int run(String[] argv) throws Exception {
}
/**
- * Dispatches command-line arguments to the tool via the <code>ToolRunner</code>.
+ * Dispatches command-line arguments to the tool via the {@code ToolRunner}.
+ *
+ * @param args command-line arguments
+ * @throws Exception if tool encounters an exception
*/
public static void main(String[] args) throws Exception {
int res = ToolRunner.run(new EncodeBfsGraph(), args);
@@ -128,7 +128,10 @@ public int run(String[] argv) throws Exception {
}
/**
- * Dispatches command-line arguments to the tool via the <code>ToolRunner</code>.
+ * Dispatches command-line arguments to the tool via the {@code ToolRunner}.
+ *
+ * @param args command-line arguments
+ * @throws Exception if tool encounters an exception
*/
public static void main(String[] args) throws Exception {
int res = ToolRunner.run(new FindNodeAtDistance(), args);
@@ -115,7 +115,10 @@ public int run(String[] argv) throws Exception {
}
/**
- * Dispatches command-line arguments to the tool via the <code>ToolRunner</code>.
+ * Dispatches command-line arguments to the tool via the {@code ToolRunner}.
+ *
+ * @param args command-line arguments
+ * @throws Exception if tool encounters an exception
*/
public static void main(String[] args) throws Exception {
int res = ToolRunner.run(new FindReachableNodes(), args);
@@ -240,7 +240,10 @@ public int run(String[] argv) throws Exception {
}
/**
- * Dispatches command-line arguments to the tool via the <code>ToolRunner</code>.
+ * Dispatches command-line arguments to the tool via the {@code ToolRunner}.
+ *
+ * @param args command-line arguments
+ * @throws Exception if tool encounters an exception
*/
public static void main(String[] args) throws Exception {
int res = ToolRunner.run(new IterateBfs(), args);
@@ -149,6 +149,9 @@ public int run(String[] argv) throws Exception {
/**
* Dispatches command-line arguments to the tool via the {@code ToolRunner}.
+ *
+ * @param args command-line arguments
+ * @throws Exception if tool encounters an exception
*/
public static void main(String[] args) throws Exception {
ToolRunner.run(new BigramCount(), args);
@@ -194,6 +194,9 @@ public int run(String[] argv) throws Exception {
/**
* Dispatches command-line arguments to the tool via the {@code ToolRunner}.
+ *
+ * @param args command-line arguments
+ * @throws Exception if tool encounters an exception
*/
public static void main(String[] args) throws Exception {
ToolRunner.run(new ComputeBigramRelativeFrequencyPairs(), args);
@@ -198,6 +198,9 @@ public int run(String[] argv) throws Exception {
/**
* Dispatches command-line arguments to the tool via the {@code ToolRunner}.
+ *
+ * @param args command-line arguments
+ * @throws Exception if tool encounters an exception
*/
public static void main(String[] args) throws Exception {
ToolRunner.run(new ComputeBigramRelativeFrequencyStripes(), args);
@@ -183,6 +183,9 @@ public int run(String[] argv) throws Exception {
/**
* Dispatches command-line arguments to the tool via the {@code ToolRunner}.
+ *
+ * @param args command-line arguments
+ * @throws Exception if tool encounters an exception
*/
public static void main(String[] args) throws Exception {
ToolRunner.run(new ComputeCooccurrenceMatrixPairs(), args);
@@ -173,6 +173,9 @@ public int run(String[] argv) throws Exception {
/**
* Dispatches command-line arguments to the tool via the {@code ToolRunner}.
+ *
+ * @param args command-line arguments
+ * @throws Exception if tool encounters an exception
*/
public static void main(String[] args) throws Exception {
ToolRunner.run(new ComputeCooccurrenceMatrixStripes(), args);
@@ -142,6 +142,9 @@ public int run(String[] argv) throws Exception {
/**
* Dispatches command-line arguments to the tool via the {@code ToolRunner}.
+ *
+ * @param args command-line arguments
+ * @throws Exception if tool encounters an exception
*/
public static void main(String[] args) throws Exception {
ToolRunner.run(new ComputeMeanV1(), args);
@@ -159,6 +159,9 @@ public int run(String[] argv) throws Exception {
/**
* Dispatches command-line arguments to the tool via the {@code ToolRunner}.
+ *
+ * @param args command-line arguments
+ * @throws Exception if tool encounters an exception
*/
public static void main(String[] args) throws Exception {
ToolRunner.run(new ComputeMeanV2(), args);
@@ -160,6 +160,9 @@ public int run(String[] argv) throws Exception {
/**
* Dispatches command-line arguments to the tool via the {@code ToolRunner}.
+ *
+ * @param args command-line arguments
+ * @throws Exception if tool encounters an exception
*/
public static void main(String[] args) throws Exception {
ToolRunner.run(new ComputeMeanV3(), args);
@@ -185,6 +185,9 @@ public int run(String[] argv) throws Exception {
/**
* Dispatches command-line arguments to the tool via the {@code ToolRunner}.
+ *
+ * @param args command-line arguments
+ * @throws Exception if tool encounters an exception
*/
public static void main(String[] args) throws Exception {
ToolRunner.run(new ComputeMeanV4(), args);
@@ -160,6 +160,9 @@ public int run(String[] argv) throws Exception {
/**
* Dispatches command-line arguments to the tool via the {@code ToolRunner}.
+ *
+ * @param args command-line arguments
+ * @throws Exception if tool encounters an exception
*/
public static void main(String[] args) throws Exception {
ToolRunner.run(new GenerateRandomData(), args);
@@ -186,6 +186,9 @@ public int run(String[] args) throws Exception {
/**
* Dispatches command-line arguments to the tool via the {@code ToolRunner}.
+ *
+ * @param args command-line arguments
+ * @throws Exception if tool encounters an exception
*/
public static void main(String[] args) throws Exception {
ToolRunner.run(new BuildPageRankRecords(), args);
@@ -113,6 +113,9 @@ public int run(String[] args) throws Exception {
/**
* Dispatches command-line arguments to the tool via the {@code ToolRunner}.
+ *
+ * @param args command-line arguments
+ * @throws Exception if tool encounters an exception
*/
public static void main(String[] args) throws Exception {
ToolRunner.run(new DumpPageRankRecordsToPlainText(), args);
@@ -200,6 +200,9 @@ public int run(String[] args) throws Exception {
/**
* Dispatches command-line arguments to the tool via the {@code ToolRunner}.
+ *
+ * @param args command-line arguments
+ * @throws Exception if tool encounters an exception
*/
public static void main(String[] args) throws Exception {
int res = ToolRunner.run(new FindMaxPageRankNodes(), args);
@@ -91,6 +91,7 @@ public void setType(Type type) {
* Deserializes this object.
*
* @param in source for raw byte representation
+ * @throws IOException if any exception is encountered during object deserialization
*/
@Override
public void readFields(DataInput in) throws IOException {
@@ -115,6 +116,7 @@ public void readFields(DataInput in) throws IOException {
* Serializes this object.
*
* @param out where to write the raw byte representation
+ * @throws IOException if any exception is encountered during object serialization
*/
@Override
public void write(DataOutput out) throws IOException {
@@ -143,7 +145,7 @@ public String toString() {
* Returns the serialized representation of this object as a byte array.
*
* @return byte array representing the serialized representation of this object
- * @throws IOException
+ * @throws IOException if any exception is encountered during object serialization
*/
public byte[] serialize() throws IOException {
ByteArrayOutputStream bytesOut = new ByteArrayOutputStream();
@@ -158,7 +160,7 @@ public String toString() {
*
* @param in source for reading the serialized representation
* @return newly-created object
- * @throws IOException
+ * @throws IOException if any exception is encountered during object deserialization
*/
public static PageRankNode create(DataInput in) throws IOException {
PageRankNode m = new PageRankNode();
@@ -172,7 +174,7 @@ public static PageRankNode create(DataInput in) throws IOException {
*
* @param bytes raw serialized representation
* @return newly-created object
- * @throws IOException
+ * @throws IOException if any exception is encountered during object deserialization
*/
public static PageRankNode create(byte[] bytes) throws IOException {
return create(new DataInputStream(new ByteArrayInputStream(bytes)));
@@ -360,6 +360,9 @@ public void map(IntWritable nid, PageRankNode node, Context context)
/**
* Dispatches command-line arguments to the tool via the {@code ToolRunner}.
+ *
+ * @param args command-line arguments
+ * @throws Exception if tool encounters an exception
*/
public static void main(String[] args) throws Exception {
ToolRunner.run(new RunPageRankBasic(), args);
@@ -408,6 +408,9 @@ public void map(IntWritable nid, PageRankNode node, Context context)
/**
* Dispatches command-line arguments to the tool via the {@code ToolRunner}.
+ *
+ * @param args command-line arguments
+ * @throws Exception if tool encounters an exception
*/
public static void main(String[] args) throws Exception {
ToolRunner.run(new RunPageRankSchimmy(), args);
@@ -186,6 +186,9 @@ public int run(String[] argv) throws Exception {
/**
* Dispatches command-line arguments to the tool via the {@code ToolRunner}.
+ *
+ * @param args command-line arguments
+ * @throws Exception if tool encounters an exception
*/
public static void main(String[] args) throws Exception {
ToolRunner.run(new BooleanRetrieval(), args);
@@ -160,6 +160,9 @@ public int run(String[] argv) throws Exception {
/**
* Dispatches command-line arguments to the tool via the {@code ToolRunner}.
+ *
+ * @param args command-line arguments
+ * @throws Exception if tool encounters an exception
*/
public static void main(String[] args) throws Exception {
ToolRunner.run(new BuildInvertedIndex(), args);
@@ -159,6 +159,9 @@ public int run(String[] argv) throws Exception {
/**
* Dispatches command-line arguments to the tool via the {@code ToolRunner}.
+ *
+ * @param args command-line arguments
+ * @throws Exception if tool encounters an exception
*/
public static void main(String[] args) throws Exception {
ToolRunner.run(new HBaseWordCount(), args);
@@ -91,6 +91,9 @@ public int run(String[] argv) throws Exception {
/**
* Dispatches command-line arguments to the tool via the {@code ToolRunner}.
+ *
+ * @param args command-line arguments
+ * @throws Exception if tool encounters an exception
*/
public static void main(String[] args) throws Exception {
ToolRunner.run(new HBaseWordCountFetch(), args);
@@ -191,6 +191,9 @@ public int run(String[] argv) throws Exception {
/**
* Dispatches command-line arguments to the tool via the {@code ToolRunner}.
+ *
+ * @param args command-line arguments
+ * @throws Exception if tool encounters an exception
*/
public static void main(String[] args) throws Exception {
ToolRunner.run(new WordCount(), args);

0 comments on commit 27e19a4

Please sign in to comment.