This is an automated email from the ASF dual-hosted git repository.
ctubbsii pushed a commit to branch 2.0
in repository https://gitbox.apache.org/repos/asf/accumulo.git
The following commit(s) were added to refs/heads/2.0 by this push:
new ec76015 Fix javadocs when building with Java 11
ec76015 is described below
commit ec76015d6e357d3a799fc2507ae0c4f33e53bba0
Author: Christopher Tubbs <[email protected]>
AuthorDate: Sun Jun 16 17:50:11 2019 -0400
Fix javadocs when building with Java 11
* Update maven-javadoc-plugin
* Drop `<javadocVersion>` from maven-javadoc-plugin configuration
* Replace `<tt>` tags with `<code>`, since the former is no longer supported
* Add `<caption>` for tables (weird Java 11 javadoc requirement)
* Also update hibernate-validator groupId (not javadoc related, but
removed build warning from Maven about relocated artifact)
---
assemble/pom.xml | 2 +-
assemble/src/main/assemblies/component.xml | 2 +-
.../data/doc-files/mutation-serialization.html | 322 ++++++++++-----------
.../org/apache/accumulo/core/iterators/Filter.java | 2 +-
.../accumulo/core/iterators/ServerFilter.java | 2 +-
.../core/iterators/SortedKeyValueIterator.java | 36 +--
.../core/iterators/SynchronizedServerFilter.java | 2 +-
.../accumulo/core/iterators/YieldCallback.java | 2 +-
pom.xml | 4 +-
.../tserver/compaction/CompactionStrategy.java | 2 +-
.../strategies/BasicCompactionStrategy.java | 2 +-
11 files changed, 185 insertions(+), 193 deletions(-)
diff --git a/assemble/pom.xml b/assemble/pom.xml
index c45c7ea..922fab3 100644
--- a/assemble/pom.xml
+++ b/assemble/pom.xml
@@ -434,7 +434,7 @@
<optional>true</optional>
</dependency>
<dependency>
- <groupId>org.hibernate</groupId>
+ <groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
<optional>true</optional>
</dependency>
diff --git a/assemble/src/main/assemblies/component.xml
b/assemble/src/main/assemblies/component.xml
index d8fcd98..aa71c42 100644
--- a/assemble/src/main/assemblies/component.xml
+++ b/assemble/src/main/assemblies/component.xml
@@ -97,7 +97,7 @@
<include>org.glassfish.jersey.media:jersey-media-json-jackson</include>
<include>org.glassfish.web:el-impl</include>
<include>org.glassfish.web:javax.el</include>
- <include>org.hibernate:hibernate-validator</include>
+ <include>org.hibernate.validator:hibernate-validator</include>
<include>org.javassist:javassist</include>
<include>org.jboss.logging:jboss-logging</include>
<include>org.slf4j:slf4j-api</include>
diff --git
a/core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html
b/core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html
index d4d5ed3..f00d1b7 100644
---
a/core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html
+++
b/core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html
@@ -1,6 +1,3 @@
-<html>
-<head>
- <title>Serialization Formats for Mutation</title>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -17,180 +14,175 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-</head>
-<body>
+<html>
+ <head>
+ <title>Serialization Formats for Mutation</title>
+ </head>
+ <body>
<p>
- The <code>Mutation</code> class supports two serialization formats.
- While it only currently serializes to the newer version 2 format, it
- can read both version 1 and version 2 serialized forms.
+ The <code>Mutation</code> class supports two serialization formats.
+ While it only currently serializes to the newer version 2 format, it
+ can read both version 1 and version 2 serialized forms.
</p>
<h2>Version 1 Format</h2>
- <p>
- Mutation data serialized in the version 1 format has the following
- layout.
- </p>
<table>
- <tr>
- <th>data location</th>
- <th>description</th>
- </tr>
- <tr>
- <td>bytes 0 through 3</td>
- <td>4-byte integer for length of row ID</td>
- </tr>
- <tr>
- <td>next <i>n</i> bytes</td>
- <td>row ID</td>
- </tr>
- <tr>
- <td>next integer</td>
- <td>data length</td>
- </tr>
- <tr>
- <td>next <i>n</i> bytes</td>
- <td>data (see below)</td>
- </tr>
- <tr>
- <td>next integer</td>
- <td>number of entries</td>
- </tr>
- <tr>
- <td>next boolean</td>
- <td>values present flag</td>
- </tr>
- <tr>
- <td>next integer</td>
- <td>number of values (only if values present flag is set)</td>
- </tr>
- <tr>
- <td>next <i>n</i> sets of integers and byte arrays</td>
- <td><i>n</i> value lengths and value data bytes (only if values
- present flag is set)</td>
- </tr>
+ <caption>Version 1 mutation data serialization layout</caption>
+ <tr>
+ <th>data location</th>
+ <th>description</th>
+ </tr>
+ <tr>
+ <td>bytes 0 through 3</td>
+ <td>4-byte integer for length of row ID</td>
+ </tr>
+ <tr>
+ <td>next <i>n</i> bytes</td>
+ <td>row ID</td>
+ </tr>
+ <tr>
+ <td>next integer</td>
+ <td>data length</td>
+ </tr>
+ <tr>
+ <td>next <i>n</i> bytes</td>
+ <td>data (see below)</td>
+ </tr>
+ <tr>
+ <td>next integer</td>
+ <td>number of entries</td>
+ </tr>
+ <tr>
+ <td>next boolean</td>
+ <td>values present flag</td>
+ </tr>
+ <tr>
+ <td>next integer</td>
+ <td>number of values (only if values present flag is set)</td>
+ </tr>
+ <tr>
+ <td>next <i>n</i> sets of integers and byte arrays</td>
+ <td><i>n</i> value lengths and value data bytes (only if values
+ present flag is set)</td>
+ </tr>
</table>
- <p>
- The "data" block noted above has the following layout for each entry.
- </p>
<table>
- <tr>
- <td>first integer and byte array</td>
- <td>column family length and bytes</td>
- </tr>
- <tr>
- <td>next integer and byte array</td>
- <td>column qualifier length and bytes</td>
- </tr>
- <tr>
- <td>next integer and byte array</td>
- <td>column visibility length and bytes</td>
- </tr>
- <tr>
- <td>next boolean</td>
- <td>has timestamp flag</td>
- </tr>
- <tr>
- <td>next long</td>
- <td>timestamp</td>
- </tr>
- <tr>
- <td>next boolean</td>
- <td>deleted flag</td>
- </tr>
- <tr>
- <td>next integer</td>
- <td>value length; if negative, value bytes are the same as those
- for already-read value (-length - 1)</td>
- </tr>
- <tr>
- <td>next <i>n</i> bytes</td>
- <td>value bytes (only if value length is non-negative)</td>
- </tr>
+ <caption>Version 1 "data" block layout for each entry</caption>
+ <tr>
+ <td>first integer and byte array</td>
+ <td>column family length and bytes</td>
+ </tr>
+ <tr>
+ <td>next integer and byte array</td>
+ <td>column qualifier length and bytes</td>
+ </tr>
+ <tr>
+ <td>next integer and byte array</td>
+ <td>column visibility length and bytes</td>
+ </tr>
+ <tr>
+ <td>next boolean</td>
+ <td>has timestamp flag</td>
+ </tr>
+ <tr>
+ <td>next long</td>
+ <td>timestamp</td>
+ </tr>
+ <tr>
+ <td>next boolean</td>
+ <td>deleted flag</td>
+ </tr>
+ <tr>
+ <td>next integer</td>
+ <td>value length; if negative, value bytes are the same as those
+ for already-read value (-length - 1)</td>
+ </tr>
+ <tr>
+ <td>next <i>n</i> bytes</td>
+ <td>value bytes (only if value length is non-negative)</td>
+ </tr>
</table>
<h2>Version 2 Format</h2>
- <p>
- Mutation data serialized in the version 2 format has the following
- layout. This format uses variable length encoding for integers and
- longs.
- </p>
<table>
- <tr>
- <th>data location</th>
- <th>description</th>
- </tr>
- <tr>
- <td>byte 0</td>
- <td>control byte: top bit = 1 for version 2; bottom bit =
- values present flag</td>
- </tr>
- <tr>
- <td>next integer
- <td>length of row ID</td>
- </tr>
- <tr>
- <td>next <i>n</i> bytes</td>
- <td>row ID</td>
- </tr>
- <tr>
- <td>next integer</td>
- <td>data length</td>
- </tr>
- <tr>
- <td>next <i>n</i> bytes</td>
- <td>data (see below)</td>
- </tr>
- <tr>
- <td>next integer</td>
- <td>number of entries</td>
- </tr>
- <tr>
- <td>next integer</td>
- <td>number of values (only if values present flag is set)</td>
- </tr>
- <tr>
- <td>next <i>n</i> sets of integers and byte arrays</td>
- <td><i>n</i> value lengths and value data bytes (only if values
- present flag is set)</td>
- </tr>
+ <caption>
+ Version 2 mutation data serialization layout<br>
+ (variable length encoding for integers and longs)
+ </caption>
+ <tr>
+ <th>data location</th>
+ <th>description</th>
+ </tr>
+ <tr>
+ <td>byte 0</td>
+ <td>control byte: top bit = 1 for version 2; bottom bit =
+ values present flag</td>
+ </tr>
+ <tr>
+ <td>next integer
+ <td>length of row ID</td>
+ </tr>
+ <tr>
+ <td>next <i>n</i> bytes</td>
+ <td>row ID</td>
+ </tr>
+ <tr>
+ <td>next integer</td>
+ <td>data length</td>
+ </tr>
+ <tr>
+ <td>next <i>n</i> bytes</td>
+ <td>data (see below)</td>
+ </tr>
+ <tr>
+ <td>next integer</td>
+ <td>number of entries</td>
+ </tr>
+ <tr>
+ <td>next integer</td>
+ <td>number of values (only if values present flag is set)</td>
+ </tr>
+ <tr>
+ <td>next <i>n</i> sets of integers and byte arrays</td>
+ <td><i>n</i> value lengths and value data bytes (only if values
+ present flag is set)</td>
+ </tr>
</table>
- <p>
- The "data" block noted above has the following layout for each entry.
- </p>
<table>
- <tr>
- <td>first long and byte array</td>
- <td>column family length and bytes</td>
- </tr>
- <tr>
- <td>next long and byte array</td>
- <td>column qualifier length and bytes</td>
- </tr>
- <tr>
- <td>next long and byte array</td>
- <td>column visibility length and bytes</td>
- </tr>
- <tr>
- <td>next boolean</td>
- <td>has timestamp flag</td>
- </tr>
- <tr>
- <td>next long</td>
- <td>timestamp (only present if timestamp flag is set)</td>
- </tr>
- <tr>
- <td>next boolean</td>
- <td>deleted flag</td>
- </tr>
- <tr>
- <td>next long</td>
- <td>value length; if negative, value bytes are the same as those
- for already-read value (-length - 1)</td>
- </tr>
- <tr>
- <td>next <i>n</i> bytes</td>
- <td>value bytes (only if value length is non-negative)</td>
- </tr>
+ <caption>Version 2 "data" block layout for each entry</caption>
+ <tr>
+ <td>first long and byte array</td>
+ <td>column family length and bytes</td>
+ </tr>
+ <tr>
+ <td>next long and byte array</td>
+ <td>column qualifier length and bytes</td>
+ </tr>
+ <tr>
+ <td>next long and byte array</td>
+ <td>column visibility length and bytes</td>
+ </tr>
+ <tr>
+ <td>next boolean</td>
+ <td>has timestamp flag</td>
+ </tr>
+ <tr>
+ <td>next long</td>
+ <td>timestamp (only present if timestamp flag is set)</td>
+ </tr>
+ <tr>
+ <td>next boolean</td>
+ <td>deleted flag</td>
+ </tr>
+ <tr>
+ <td>next long</td>
+ <td>value length; if negative, value bytes are the same as those
+ for already-read value (-length - 1)</td>
+ </tr>
+ <tr>
+ <td>next <i>n</i> bytes</td>
+ <td>value bytes (only if value length is non-negative)</td>
+ </tr>
</table>
-</body>
+ </body>
</html>
diff --git a/core/src/main/java/org/apache/accumulo/core/iterators/Filter.java
b/core/src/main/java/org/apache/accumulo/core/iterators/Filter.java
index 8c39fef..c67252f 100644
--- a/core/src/main/java/org/apache/accumulo/core/iterators/Filter.java
+++ b/core/src/main/java/org/apache/accumulo/core/iterators/Filter.java
@@ -83,7 +83,7 @@ public abstract class Filter extends WrappingIterator
implements OptionDescriber
}
/**
- * @return <tt>true</tt> if the key/value pair is accepted by the filter.
+ * @return <code>true</code> if the key/value pair is accepted by the filter.
*/
public abstract boolean accept(Key k, Value v);
diff --git
a/core/src/main/java/org/apache/accumulo/core/iterators/ServerFilter.java
b/core/src/main/java/org/apache/accumulo/core/iterators/ServerFilter.java
index bf9dd97..3eac419 100644
--- a/core/src/main/java/org/apache/accumulo/core/iterators/ServerFilter.java
+++ b/core/src/main/java/org/apache/accumulo/core/iterators/ServerFilter.java
@@ -71,7 +71,7 @@ public abstract class ServerFilter extends
ServerWrappingIterator {
}
/**
- * @return <tt>true</tt> if the key/value pair is accepted by the filter.
+ * @return <code>true</code> if the key/value pair is accepted by the filter.
*/
public abstract boolean accept(Key k, Value v);
diff --git
a/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java
b/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java
index de3b204..c4da1d1 100644
---
a/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java
+++
b/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java
@@ -36,11 +36,11 @@ public interface SortedKeyValueIterator<K extends
WritableComparable<?>,V extend
* Initializes the iterator. Data should not be read from the source in this
method.
*
* @param source
- * <tt>SortedKeyValueIterator</tt> source to read data from.
+ * <code>SortedKeyValueIterator</code> source to read data from.
* @param options
- * <tt>Map</tt> map of string option names to option values.
+ * <code>Map</code> map of string option names to option values.
* @param env
- * <tt>IteratorEnvironment</tt> environment in which iterator is
being run.
+ * <code>IteratorEnvironment</code> environment in which iterator
is being run.
* @throws IOException
* unused.
* @exception IllegalArgumentException
@@ -55,7 +55,7 @@ public interface SortedKeyValueIterator<K extends
WritableComparable<?>,V extend
* Returns true if the iterator has more elements. Note that if this
iterator has yielded (@see
* YieldingKeyValueIterator.enableYielding(YieldCallback)), this this method
must return false.
*
- * @return <tt>true</tt> if the iterator has more elements.
+ * @return <code>true</code> if the iterator has more elements.
* @exception IllegalStateException
* if called before seek.
*/
@@ -100,12 +100,12 @@ public interface SortedKeyValueIterator<K extends
WritableComparable<?>,V extend
* ensure that data from separate locality groups is not inadvertently read.
*
* @param range
- * <tt>Range</tt> of keys to iterate over.
+ * <code>Range</code> of keys to iterate over.
* @param columnFamilies
- * <tt>Collection</tt> of column families to include or exclude.
+ * <code>Collection</code> of column families to include or exclude.
* @param inclusive
- * <tt>boolean</tt> that indicates whether to include (true) or
exclude (false) column
- * families.
+ * <code>boolean</code> that indicates whether to include (true) or
exclude (false)
+ * column families.
* @throws IOException
* if an I/O error occurs.
* @exception IllegalArgumentException
@@ -122,11 +122,11 @@ public interface SortedKeyValueIterator<K extends
WritableComparable<?>,V extend
* scopes. Deletion entries are only removed during full major compactions.
* <p>
* For performance reasons, iterators reserve the right to reuse objects
returned by
- * <tt>getTopKey</tt> when {@link #next()} is called, changing the data that
the object
- * references. Iterators that need to save an object returned by
<tt>getTopKey</tt> ought to copy
- * the object's data into a new object in order to avoid aliasing bugs.
+ * <code>getTopKey</code> when {@link #next()} is called, changing the data
that the object
+ * references. Iterators that need to save an object returned by
<code>getTopKey</code> ought to
+ * copy the object's data into a new object in order to avoid aliasing bugs.
*
- * @return <tt>K</tt>
+ * @return <code>K</code>
* @exception IllegalStateException
* if called before seek.
* @exception NoSuchElementException
@@ -139,11 +139,11 @@ public interface SortedKeyValueIterator<K extends
WritableComparable<?>,V extend
* hasTop().
* <p>
* For performance reasons, iterators reserve the right to reuse objects
returned by
- * <tt>getTopValue</tt> when {@link #next()} is called, changing the
underlying data that the
- * object references. Iterators that need to save an object returned by
<tt>getTopValue</tt> ought
- * to copy the object's data into a new object in order to avoid aliasing
bugs.
+ * <code>getTopValue</code> when {@link #next()} is called, changing the
underlying data that the
+ * object references. Iterators that need to save an object returned by
<code>getTopValue</code>
+ * ought to copy the object's data into a new object in order to avoid
aliasing bugs.
*
- * @return <tt>V</tt>
+ * @return <code>V</code>
* @exception IllegalStateException
* if called before seek.
* @exception NoSuchElementException
@@ -159,8 +159,8 @@ public interface SortedKeyValueIterator<K extends
WritableComparable<?>,V extend
* either on the original or the copy. A proper implementation would call
deepCopy on the source.
*
* @param env
- * <tt>IteratorEnvironment</tt> environment in which iterator is
being run.
- * @return <tt>SortedKeyValueIterator</tt> a copy of this iterator (with the
same source and
+ * <code>IteratorEnvironment</code> environment in which iterator
is being run.
+ * @return <code>SortedKeyValueIterator</code> a copy of this iterator (with
the same source and
* settings).
* @exception UnsupportedOperationException
* if not supported.
diff --git
a/core/src/main/java/org/apache/accumulo/core/iterators/SynchronizedServerFilter.java
b/core/src/main/java/org/apache/accumulo/core/iterators/SynchronizedServerFilter.java
index 9b98fa4..951b075 100644
---
a/core/src/main/java/org/apache/accumulo/core/iterators/SynchronizedServerFilter.java
+++
b/core/src/main/java/org/apache/accumulo/core/iterators/SynchronizedServerFilter.java
@@ -86,7 +86,7 @@ public abstract class SynchronizedServerFilter implements
SortedKeyValueIterator
}
/**
- * @return <tt>true</tt> if the key/value pair is accepted by the filter.
+ * @return <code>true</code> if the key/value pair is accepted by the filter.
*/
protected abstract boolean accept(Key k, Value v);
diff --git
a/core/src/main/java/org/apache/accumulo/core/iterators/YieldCallback.java
b/core/src/main/java/org/apache/accumulo/core/iterators/YieldCallback.java
index 2e19b62..dd25031 100644
--- a/core/src/main/java/org/apache/accumulo/core/iterators/YieldCallback.java
+++ b/core/src/main/java/org/apache/accumulo/core/iterators/YieldCallback.java
@@ -46,7 +46,7 @@ public class YieldCallback<K> {
* range in a subsequent seek call when the iterator is rebuilt. This will
also reset the state
* returned by hasYielded.
*
- * @return <tt>K</tt> The key position
+ * @return <code>K</code> The key position
*/
public K getPositionAndReset() {
try {
diff --git a/pom.xml b/pom.xml
index 6e569be..720bc60 100644
--- a/pom.xml
+++ b/pom.xml
@@ -708,7 +708,7 @@
<version>1.3</version>
</dependency>
<dependency>
- <groupId>org.hibernate</groupId>
+ <groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.0.17.Final</version>
</dependency>
@@ -878,9 +878,9 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
+ <version>3.1.0</version>
<configuration>
<quiet>true</quiet>
- <javadocVersion>1.8.0</javadocVersion>
<additionalJOption>-J-Xmx512m</additionalJOption>
<doclint>all,-missing</doclint>
</configuration>
diff --git
a/server/tserver/src/main/java/org/apache/accumulo/tserver/compaction/CompactionStrategy.java
b/server/tserver/src/main/java/org/apache/accumulo/tserver/compaction/CompactionStrategy.java
index 54ee836..9f6eeb9 100644
---
a/server/tserver/src/main/java/org/apache/accumulo/tserver/compaction/CompactionStrategy.java
+++
b/server/tserver/src/main/java/org/apache/accumulo/tserver/compaction/CompactionStrategy.java
@@ -38,7 +38,7 @@ import java.util.Map;
public abstract class CompactionStrategy {
/**
* The settings for the compaction strategy pulled from zookeeper. The
- * <tt>table.compacations.major.strategy.opts</tt> part of the setting will
be removed.
+ * <code>table.compacations.major.strategy.opts</code> part of the setting
will be removed.
*/
public void init(Map<String,String> options) {}
diff --git
a/server/tserver/src/main/java/org/apache/accumulo/tserver/compaction/strategies/BasicCompactionStrategy.java
b/server/tserver/src/main/java/org/apache/accumulo/tserver/compaction/strategies/BasicCompactionStrategy.java
index f24910d..ad3866a 100644
---
a/server/tserver/src/main/java/org/apache/accumulo/tserver/compaction/strategies/BasicCompactionStrategy.java
+++
b/server/tserver/src/main/java/org/apache/accumulo/tserver/compaction/strategies/BasicCompactionStrategy.java
@@ -68,7 +68,7 @@ public class BasicCompactionStrategy extends
DefaultCompactionStrategy {
/**
* Threshold memory in bytes. Files larger than this threshold will use
- * <tt>table.majc.compaction.strategy.opts.file.large.compress.type</tt> for
compression
+ * <code>table.majc.compaction.strategy.opts.file.large.compress.type</code>
for compression
*/
public static final String LARGE_FILE_COMPRESSION_THRESHOLD =
"large.compress.threshold";
