Fixed javadoc errors
diff --git a/modules/api/src/main/java/io/fluo/api/client/FluoAdmin.java b/modules/api/src/main/java/io/fluo/api/client/FluoAdmin.java
index 56faafc..395e6cd 100644
--- a/modules/api/src/main/java/io/fluo/api/client/FluoAdmin.java
+++ b/modules/api/src/main/java/io/fluo/api/client/FluoAdmin.java
@@ -110,8 +110,8 @@
* {@value io.fluo.api.config.FluoConfiguration#APP_PREFIX},
* {@value io.fluo.api.config.FluoConfiguration#OBSERVER_PREFIX} and
* {@value io.fluo.api.config.FluoConfiguration#TRANSACTION_PREFIX} prefixes. This method is
- * called if a user has previously called {@link #initialize()} but wants changes to shared
- * configuration updated in Zookeeper.
+ * called if a user has previously called {@link #initialize(InitOpts)} but wants changes to
+ * shared configuration updated in Zookeeper.
*
* <p>
* During this method Observers are reinitialized using configuration passed to FluoAdmin and not
diff --git a/modules/api/src/main/java/io/fluo/api/client/FluoClient.java b/modules/api/src/main/java/io/fluo/api/client/FluoClient.java
index fd3c70e..25c85a5 100644
--- a/modules/api/src/main/java/io/fluo/api/client/FluoClient.java
+++ b/modules/api/src/main/java/io/fluo/api/client/FluoClient.java
@@ -38,8 +38,8 @@
/**
* Creates a {@link Transaction} for reading and writing data to Fluo. Unlike the transactions
- * provided by the {@link Loader} and {@link Observer}, users will need to call
- * {@link Transaction#commit()}. Use within a try-with-resources statement or call
+ * provided by the {@link Loader} and {@link io.fluo.api.observer.Observer}, users will need to
+ * call {@link Transaction#commit()}. Use within a try-with-resources statement or call
* {@link Transaction#close()} when you are finished.
*
* <p>
diff --git a/modules/api/src/main/java/io/fluo/api/config/ObserverConfiguration.java b/modules/api/src/main/java/io/fluo/api/config/ObserverConfiguration.java
index aa0c4bc..6739d27 100644
--- a/modules/api/src/main/java/io/fluo/api/config/ObserverConfiguration.java
+++ b/modules/api/src/main/java/io/fluo/api/config/ObserverConfiguration.java
@@ -23,7 +23,7 @@
/**
* Used to pass configuration to an {@link AbstractObserver}. Set using
- * {@link FluoConfiguration#setObservers(java.util.List)}
+ * {@link FluoConfiguration#addObserver(ObserverConfiguration)}
*/
public class ObserverConfiguration {
private final String className;
diff --git a/modules/api/src/main/java/io/fluo/api/config/ScannerConfiguration.java b/modules/api/src/main/java/io/fluo/api/config/ScannerConfiguration.java
index 12352db..3d61da5 100644
--- a/modules/api/src/main/java/io/fluo/api/config/ScannerConfiguration.java
+++ b/modules/api/src/main/java/io/fluo/api/config/ScannerConfiguration.java
@@ -25,7 +25,7 @@
import io.fluo.api.data.Span;
/**
- * Contains configuration for a {@link Snapshot} scanner. Passed to
+ * Contains configuration for a {@link io.fluo.api.client.Snapshot} scanner. Passed to
* {@link SnapshotBase#get(ScannerConfiguration)}.
*/
public class ScannerConfiguration implements Cloneable {
diff --git a/modules/api/src/main/java/io/fluo/api/data/Bytes.java b/modules/api/src/main/java/io/fluo/api/data/Bytes.java
index b1918ee..4b2ea40 100644
--- a/modules/api/src/main/java/io/fluo/api/data/Bytes.java
+++ b/modules/api/src/main/java/io/fluo/api/data/Bytes.java
@@ -33,7 +33,7 @@
/**
* Represents bytes in Fluo. Similar to an Accumulo ByteSequence. Bytes is immutable after it is
- * created. {@link Bytes.EMPTY} is used to represent a Bytes object with no data.
+ * created. Bytes.EMPTY is used to represent a Bytes object with no data.
*/
public abstract class Bytes implements Comparable<Bytes>, Serializable {
diff --git a/modules/api/src/main/java/io/fluo/api/data/Column.java b/modules/api/src/main/java/io/fluo/api/data/Column.java
index e3bae31..d618680 100644
--- a/modules/api/src/main/java/io/fluo/api/data/Column.java
+++ b/modules/api/src/main/java/io/fluo/api/data/Column.java
@@ -20,8 +20,8 @@
/**
* Represents all or a subset of the column family, column qualifier, and column visibility fields.
- * A column with no fields set is represented by {@link Column.EMPTY}. Column is immutable after it
- * is created.
+ * A column with no fields set is represented by Column.EMPTY. Column is immutable after it is
+ * created.
*/
public class Column implements Comparable<Column>, Serializable {
@@ -99,7 +99,7 @@
}
/**
- * Retrieves Column Family (in Bytes). Returns {@link Bytes.EMPTY} if not set.
+ * Retrieves Column Family (in Bytes). Returns Bytes.EMPTY if not set.
*/
public Bytes getFamily() {
if (!isFamilySet()) {
@@ -116,7 +116,7 @@
}
/**
- * Retrieves Column Qualifier (in Bytes). Returns {@link Bytes.EMPTY} if not set.
+ * Retrieves Column Qualifier (in Bytes). Returns Bytes.EMPTY if not set.
*/
public Bytes getQualifier() {
if (!isQualifierSet()) {
@@ -133,7 +133,7 @@
}
/**
- * Retrieves Column Visibility (in Bytes). Returns {@link Bytes.EMPTY} if not set.
+ * Retrieves Column Visibility (in Bytes). Returns Bytes.EMPTY if not set.
*/
public Bytes getVisibility() {
if (!isVisibilitySet()) {
diff --git a/modules/api/src/main/java/io/fluo/api/data/Span.java b/modules/api/src/main/java/io/fluo/api/data/Span.java
index ea40b39..0ec0e1c 100644
--- a/modules/api/src/main/java/io/fluo/api/data/Span.java
+++ b/modules/api/src/main/java/io/fluo/api/data/Span.java
@@ -31,7 +31,7 @@
private boolean endInclusive = true;
/**
- * Constructs a span with infinite start & end
+ * Constructs a span with infinite start and end
*/
public Span() {}
diff --git a/modules/api/src/main/java/io/fluo/api/observer/AbstractObserver.java b/modules/api/src/main/java/io/fluo/api/observer/AbstractObserver.java
index c6b027f..c4ba9a7 100644
--- a/modules/api/src/main/java/io/fluo/api/observer/AbstractObserver.java
+++ b/modules/api/src/main/java/io/fluo/api/observer/AbstractObserver.java
@@ -17,10 +17,12 @@
import io.fluo.api.client.TransactionBase;
/**
- * Implemented by users to a watch a {@link Column} and be notified of changes to the Column via the
- * {@link #process(TransactionBase, Bytes, Column)} method. AbstractObserver extends
- * {@link Observer} but provides a default implementation for the {@link #init(Context)} and
- * {@link #close()} method so that they can be optionally implemented by user.
+ * Implemented by users to a watch a {@link io.fluo.api.data.Column} and be notified of changes to
+ * the Column via the
+ * {@link #process(TransactionBase, io.fluo.api.data.Bytes, io.fluo.api.data.Column)} method.
+ * AbstractObserver extends {@link Observer} but provides a default implementation for the
+ * {@link #init(Context)} and {@link #close()} method so that they can be optionally implemented by
+ * user.
*/
public abstract class AbstractObserver implements Observer {
diff --git a/modules/api/src/main/java/io/fluo/api/observer/Observer.java b/modules/api/src/main/java/io/fluo/api/observer/Observer.java
index ad925e7..ce8d4bf 100644
--- a/modules/api/src/main/java/io/fluo/api/observer/Observer.java
+++ b/modules/api/src/main/java/io/fluo/api/observer/Observer.java
@@ -26,7 +26,7 @@
* Implemented by users to a watch a {@link Column} and be notified of changes to the Column via the
* {@link #process(TransactionBase, Bytes, Column)} method. An observer is created for each worker
* thread and reused for the lifetime of a worker thread. Consider extending
- * {@link AbstractObserver} as it will let you optionally implement {@link #init(Configuration)} and
+ * {@link AbstractObserver} as it will let you optionally implement {@link #init(Context)} and
* {@link #close()}. The abstract class will also shield you from the addition of interface methods.
*/
public interface Observer {
diff --git a/modules/api/src/main/java/io/fluo/api/types/TypeLayer.java b/modules/api/src/main/java/io/fluo/api/types/TypeLayer.java
index bcaf5a7..ea10986 100644
--- a/modules/api/src/main/java/io/fluo/api/types/TypeLayer.java
+++ b/modules/api/src/main/java/io/fluo/api/types/TypeLayer.java
@@ -207,7 +207,6 @@
*
* <pre>
* {@code
- *
* // pretend this method has curly braces. javadoc has issues with less than.
*
* void process(TypedTransaction tx, byte[] r, Column c1, Column c2, Column c3, long amount)
@@ -223,7 +222,7 @@
*
* // If c3 does not exist in map, then val9 will be set to 9.
* Long val3 = columns.get(c3).toLong(9);
- * @code}
+ * }
* </pre>
*
* <p>
@@ -232,7 +231,6 @@
*
* <pre>
* {@code
- *
* // pretend this method has curly braces. javadoc has issues with less than.
*
* void process(TypedTransaction tx, List<String> rows, Column c1, Column c2, Column c3,
@@ -244,7 +242,7 @@
* // this will set val1 to null if row does not exist in map and/or column does not
* // exist in child map
* String val1 = rowCols.get("row1").get(c1).toString();
- * @code}
+ * }
* </pre>
*/
diff --git a/modules/core/src/main/java/io/fluo/core/client/Operations.java b/modules/core/src/main/java/io/fluo/core/client/Operations.java
index 36c2e73..f366914 100644
--- a/modules/core/src/main/java/io/fluo/core/client/Operations.java
+++ b/modules/core/src/main/java/io/fluo/core/client/Operations.java
@@ -34,7 +34,7 @@
import org.slf4j.LoggerFactory;
/**
- * Utility methods for initializing Zookeeper & Accumulo
+ * Utility methods for initializing Zookeeper and Accumulo
*/
public class Operations {
diff --git a/modules/core/src/main/java/io/fluo/core/impl/SnapshotScanner.java b/modules/core/src/main/java/io/fluo/core/impl/SnapshotScanner.java
index 6aeceab..34a04d0 100644
--- a/modules/core/src/main/java/io/fluo/core/impl/SnapshotScanner.java
+++ b/modules/core/src/main/java/io/fluo/core/impl/SnapshotScanner.java
@@ -38,7 +38,7 @@
import org.apache.accumulo.core.data.Value;
/**
- * Allows users to iterate over entries of a {@link Snapshot}
+ * Allows users to iterate over entries of a {@link io.fluo.api.client.Snapshot}
*/
public class SnapshotScanner implements Iterator<Entry<Key, Value>> {
diff --git a/modules/core/src/main/java/io/fluo/core/oracle/OracleServer.java b/modules/core/src/main/java/io/fluo/core/oracle/OracleServer.java
index c9fdbee..8cd303b 100644
--- a/modules/core/src/main/java/io/fluo/core/oracle/OracleServer.java
+++ b/modules/core/src/main/java/io/fluo/core/oracle/OracleServer.java
@@ -62,7 +62,8 @@
* Oracle server is the responsible for providing incrementing logical timestamps to clients. It
* should never give the same timestamp to two clients and it should always provide an incrementing
* timestamp.
- * <p/>
+ *
+ * <p>
* If multiple oracle servers are run, they will choose a leader and clients will automatically
* connect to that leader. If the leader goes down, the client will automatically fail over to the
* next leader. In the case where an oracle fails over, the next oracle will begin a new block of
diff --git a/modules/core/src/main/java/io/fluo/core/util/CuratorUtil.java b/modules/core/src/main/java/io/fluo/core/util/CuratorUtil.java
index c084b71..ff87ae3 100644
--- a/modules/core/src/main/java/io/fluo/core/util/CuratorUtil.java
+++ b/modules/core/src/main/java/io/fluo/core/util/CuratorUtil.java
@@ -64,7 +64,7 @@
}
/**
- * Creates a curator built using the given zookeeper connection string & timeout
+ * Creates a curator built using the given zookeeper connection string and timeout
*/
public static CuratorFramework newCurator(String zookeepers, int timeout) {
return CuratorFrameworkFactory.newClient(zookeepers, timeout, timeout,
diff --git a/modules/mapreduce/src/main/java/io/fluo/mapreduce/FluoKeyValueGenerator.java b/modules/mapreduce/src/main/java/io/fluo/mapreduce/FluoKeyValueGenerator.java
index 00bee79..e806277 100644
--- a/modules/mapreduce/src/main/java/io/fluo/mapreduce/FluoKeyValueGenerator.java
+++ b/modules/mapreduce/src/main/java/io/fluo/mapreduce/FluoKeyValueGenerator.java
@@ -40,7 +40,7 @@
* <p>
*
* <pre>
- * {@code
+ * <code>
* // this could be shared between calls to map or reduce, to avoid creating for each call.
* FluoKeyValueGenerator fkvg = new FluoKeyValueGenerator();
* // could also reuse column objects.
@@ -58,8 +58,7 @@
* // invalidates what was returned by previous calls to getKeyValues().
* for (FluoKeyValue fluoKeyValue : fkvg.getKeyValues())
* writeToAccumuloFile(fluoKeyValue);
- *
- * @code}
+ * </code>
* </pre>
*
* <p>
