You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@accumulo.apache.org by Bill Havanki <bh...@clouderagovt.com> on 2013/11/26 19:13:44 UTC
Review Request 15857: ACCUMULO-1931 - Javadoc for core.data
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/15857/
-----------------------------------------------------------
Review request for accumulo.
Bugs: ACCUMULO-1931
https://issues.apache.org/jira/browse/ACCUMULO-1931
Repository: accumulo
Description
-------
Javadoc additions and updates to classes in org.apache.accumulo.core.data.
Diffs
-----
core/src/main/java/org/apache/accumulo/core/data/ArrayByteSequence.java eaa61b9950b691ed5955af3178a3aa939291e8bf
core/src/main/java/org/apache/accumulo/core/data/ByteSequence.java 4dc921c5efc44d374032c623f50e4218aa6c7299
core/src/main/java/org/apache/accumulo/core/data/Column.java a56c01d6604a30153739ed1329d034e3932f2e2f
core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java 641ca3a740ed384ab93f4b2d3c08c928daadfb2f
core/src/main/java/org/apache/accumulo/core/data/ComparableBytes.java ce61844375617c36ede5e0e411b439205329b023
core/src/main/java/org/apache/accumulo/core/data/Condition.java fc8f2bf0394ae658bacfa94804b4b81f19a0c0c2
core/src/main/java/org/apache/accumulo/core/data/ConstraintViolationSummary.java 2929bc610df9352374621d29caea7732bd50847d
core/src/main/java/org/apache/accumulo/core/data/Key.java de9e22d9ebff5442633dc578613fd7d033afc9c5
core/src/main/java/org/apache/accumulo/core/data/KeyValue.java cc48322f9785ad508cc7925279f5e559629f3721
core/src/main/java/org/apache/accumulo/core/data/Mutation.java 5e281f2bfef7e164c9f0e0c9a7132e94012d7186
core/src/main/java/org/apache/accumulo/core/data/PartialKey.java 2049881fe26b5f237db39a412a88e2e2017f5cc9
core/src/main/java/org/apache/accumulo/core/data/Range.java 70857348cefd0941e5ffcf6e5d569f09870101e4
core/src/main/java/org/apache/accumulo/core/data/Value.java 7d3cf8f20aa12205d25027d6ad06e4a3f6062b2e
core/src/main/java/org/apache/accumulo/core/util/UnsynchronizedBuffer.java b640581bebbb87f1ac9a36f71275fa5dc8ef1223
Diff: https://reviews.apache.org/r/15857/diff/
Testing
-------
Compiled successfully; mvn javadoc:javadoc ran with no errors from the javadoc in this patch.
Thanks,
Bill Havanki
Re: Review Request 15857: ACCUMULO-1931 - Javadoc for core.data
Posted by Bill Havanki <bh...@clouderagovt.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/15857/
-----------------------------------------------------------
(Updated Dec. 6, 2013, 2:56 p.m.)
Review request for accumulo.
Changes
-------
Add bit about encoding parameter of Condition.setValue(CharSequence) in UTF-8.
Bugs: ACCUMULO-1931
https://issues.apache.org/jira/browse/ACCUMULO-1931
Repository: accumulo
Description
-------
Javadoc additions and updates to classes in org.apache.accumulo.core.data.
Diffs (updated)
-----
core/src/main/java/org/apache/accumulo/core/data/ArrayByteSequence.java eaa61b9950b691ed5955af3178a3aa939291e8bf
core/src/main/java/org/apache/accumulo/core/data/ByteSequence.java 4dc921c5efc44d374032c623f50e4218aa6c7299
core/src/main/java/org/apache/accumulo/core/data/Column.java a56c01d6604a30153739ed1329d034e3932f2e2f
core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java 641ca3a740ed384ab93f4b2d3c08c928daadfb2f
core/src/main/java/org/apache/accumulo/core/data/ComparableBytes.java ce61844375617c36ede5e0e411b439205329b023
core/src/main/java/org/apache/accumulo/core/data/Condition.java fc8f2bf0394ae658bacfa94804b4b81f19a0c0c2
core/src/main/java/org/apache/accumulo/core/data/ConstraintViolationSummary.java 2929bc610df9352374621d29caea7732bd50847d
core/src/main/java/org/apache/accumulo/core/data/Key.java de9e22d9ebff5442633dc578613fd7d033afc9c5
core/src/main/java/org/apache/accumulo/core/data/KeyValue.java cc48322f9785ad508cc7925279f5e559629f3721
core/src/main/java/org/apache/accumulo/core/data/Mutation.java 5e281f2bfef7e164c9f0e0c9a7132e94012d7186
core/src/main/java/org/apache/accumulo/core/data/PartialKey.java 2049881fe26b5f237db39a412a88e2e2017f5cc9
core/src/main/java/org/apache/accumulo/core/data/Range.java 70857348cefd0941e5ffcf6e5d569f09870101e4
core/src/main/java/org/apache/accumulo/core/data/Value.java 7d3cf8f20aa12205d25027d6ad06e4a3f6062b2e
core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html PRE-CREATION
core/src/main/java/org/apache/accumulo/core/util/UnsynchronizedBuffer.java b640581bebbb87f1ac9a36f71275fa5dc8ef1223
Diff: https://reviews.apache.org/r/15857/diff/
Testing
-------
Compiled successfully; mvn javadoc:javadoc ran with no errors from the javadoc in this patch.
Thanks,
Bill Havanki
Re: Review Request 15857: ACCUMULO-1931 - Javadoc for core.data
Posted by Christopher Tubbs <ct...@apache.org>.
> On Dec. 6, 2013, 2:26 p.m., Sean Busbey wrote:
> > core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html, line 3
> > <https://reviews.apache.org/r/15857/diff/4/?file=393530#file393530line3>
> >
> > Just to verify, this html file will get included in the generated javadocs?
> >
> > Reading the javadoc plugin[1], it looks like maybe it needs to be in core/src/main/javadoc/org/apache/accumulo/core/data/doc-files/mutation-serialization.html
> >
> > [1]: http://maven.apache.org/plugins/maven-javadoc-plugin/examples/javadoc-resources.html
> >
>
> Bill Havanki wrote:
> It is. I'm using a capability of the javadoc tool itself[1] rather than the plugin. Interesting that there are multiple options for this.
>
> [1]: http://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#unprocessed
>
> Sean Busbey wrote:
> I saw that the javadoc tool will work with this location, just not sure if the javadoc Maven plugin changes the behavior. Might be worth moving it to src/main/javadoc to keep things more in line with "the Maven way."
>
> Bill Havanki wrote:
> (Adding comment that I had sent in email, sorry for the repetition)
>
> It still works even under the Maven plugin, i.e., I checked by running mvn javadoc:javadoc and the file was transferred. So, leaving it where it is lets it work both with and without Maven.
Why not use package-info.java, for package-level javadocs?
- Christopher
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/15857/#review29897
-----------------------------------------------------------
On Dec. 6, 2013, 2:56 p.m., Bill Havanki wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/15857/
> -----------------------------------------------------------
>
> (Updated Dec. 6, 2013, 2:56 p.m.)
>
>
> Review request for accumulo.
>
>
> Bugs: ACCUMULO-1931
> https://issues.apache.org/jira/browse/ACCUMULO-1931
>
>
> Repository: accumulo
>
>
> Description
> -------
>
> Javadoc additions and updates to classes in org.apache.accumulo.core.data.
>
>
> Diffs
> -----
>
> core/src/main/java/org/apache/accumulo/core/data/ArrayByteSequence.java eaa61b9950b691ed5955af3178a3aa939291e8bf
> core/src/main/java/org/apache/accumulo/core/data/ByteSequence.java 4dc921c5efc44d374032c623f50e4218aa6c7299
> core/src/main/java/org/apache/accumulo/core/data/Column.java a56c01d6604a30153739ed1329d034e3932f2e2f
> core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java 641ca3a740ed384ab93f4b2d3c08c928daadfb2f
> core/src/main/java/org/apache/accumulo/core/data/ComparableBytes.java ce61844375617c36ede5e0e411b439205329b023
> core/src/main/java/org/apache/accumulo/core/data/Condition.java fc8f2bf0394ae658bacfa94804b4b81f19a0c0c2
> core/src/main/java/org/apache/accumulo/core/data/ConstraintViolationSummary.java 2929bc610df9352374621d29caea7732bd50847d
> core/src/main/java/org/apache/accumulo/core/data/Key.java de9e22d9ebff5442633dc578613fd7d033afc9c5
> core/src/main/java/org/apache/accumulo/core/data/KeyValue.java cc48322f9785ad508cc7925279f5e559629f3721
> core/src/main/java/org/apache/accumulo/core/data/Mutation.java 5e281f2bfef7e164c9f0e0c9a7132e94012d7186
> core/src/main/java/org/apache/accumulo/core/data/PartialKey.java 2049881fe26b5f237db39a412a88e2e2017f5cc9
> core/src/main/java/org/apache/accumulo/core/data/Range.java 70857348cefd0941e5ffcf6e5d569f09870101e4
> core/src/main/java/org/apache/accumulo/core/data/Value.java 7d3cf8f20aa12205d25027d6ad06e4a3f6062b2e
> core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html PRE-CREATION
> core/src/main/java/org/apache/accumulo/core/util/UnsynchronizedBuffer.java b640581bebbb87f1ac9a36f71275fa5dc8ef1223
>
> Diff: https://reviews.apache.org/r/15857/diff/
>
>
> Testing
> -------
>
> Compiled successfully; mvn javadoc:javadoc ran with no errors from the javadoc in this patch.
>
>
> Thanks,
>
> Bill Havanki
>
>
Re: Review Request 15857: ACCUMULO-1931 - Javadoc for core.data
Posted by Sean Busbey <se...@manvsbeard.com>.
> On Dec. 6, 2013, 7:26 p.m., Sean Busbey wrote:
> > core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html, line 3
> > <https://reviews.apache.org/r/15857/diff/4/?file=393530#file393530line3>
> >
> > Just to verify, this html file will get included in the generated javadocs?
> >
> > Reading the javadoc plugin[1], it looks like maybe it needs to be in core/src/main/javadoc/org/apache/accumulo/core/data/doc-files/mutation-serialization.html
> >
> > [1]: http://maven.apache.org/plugins/maven-javadoc-plugin/examples/javadoc-resources.html
> >
>
> Bill Havanki wrote:
> It is. I'm using a capability of the javadoc tool itself[1] rather than the plugin. Interesting that there are multiple options for this.
>
> [1]: http://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#unprocessed
>
> Sean Busbey wrote:
> I saw that the javadoc tool will work with this location, just not sure if the javadoc Maven plugin changes the behavior. Might be worth moving it to src/main/javadoc to keep things more in line with "the Maven way."
>
> Bill Havanki wrote:
> (Adding comment that I had sent in email, sorry for the repetition)
>
> It still works even under the Maven plugin, i.e., I checked by running mvn javadoc:javadoc and the file was transferred. So, leaving it where it is lets it work both with and without Maven.
>
> Christopher Tubbs wrote:
> Why not use package-info.java, for package-level javadocs?
This particular file just provides an explanation of the Mutation serialization formats, it's not really package-level information. AFAICT, the only reason it's not going on the Mutation class directly is that there's too much to cover.
- Sean
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/15857/#review29897
-----------------------------------------------------------
On Dec. 6, 2013, 7:56 p.m., Bill Havanki wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/15857/
> -----------------------------------------------------------
>
> (Updated Dec. 6, 2013, 7:56 p.m.)
>
>
> Review request for accumulo.
>
>
> Bugs: ACCUMULO-1931
> https://issues.apache.org/jira/browse/ACCUMULO-1931
>
>
> Repository: accumulo
>
>
> Description
> -------
>
> Javadoc additions and updates to classes in org.apache.accumulo.core.data.
>
>
> Diffs
> -----
>
> core/src/main/java/org/apache/accumulo/core/data/ArrayByteSequence.java eaa61b9950b691ed5955af3178a3aa939291e8bf
> core/src/main/java/org/apache/accumulo/core/data/ByteSequence.java 4dc921c5efc44d374032c623f50e4218aa6c7299
> core/src/main/java/org/apache/accumulo/core/data/Column.java a56c01d6604a30153739ed1329d034e3932f2e2f
> core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java 641ca3a740ed384ab93f4b2d3c08c928daadfb2f
> core/src/main/java/org/apache/accumulo/core/data/ComparableBytes.java ce61844375617c36ede5e0e411b439205329b023
> core/src/main/java/org/apache/accumulo/core/data/Condition.java fc8f2bf0394ae658bacfa94804b4b81f19a0c0c2
> core/src/main/java/org/apache/accumulo/core/data/ConstraintViolationSummary.java 2929bc610df9352374621d29caea7732bd50847d
> core/src/main/java/org/apache/accumulo/core/data/Key.java de9e22d9ebff5442633dc578613fd7d033afc9c5
> core/src/main/java/org/apache/accumulo/core/data/KeyValue.java cc48322f9785ad508cc7925279f5e559629f3721
> core/src/main/java/org/apache/accumulo/core/data/Mutation.java 5e281f2bfef7e164c9f0e0c9a7132e94012d7186
> core/src/main/java/org/apache/accumulo/core/data/PartialKey.java 2049881fe26b5f237db39a412a88e2e2017f5cc9
> core/src/main/java/org/apache/accumulo/core/data/Range.java 70857348cefd0941e5ffcf6e5d569f09870101e4
> core/src/main/java/org/apache/accumulo/core/data/Value.java 7d3cf8f20aa12205d25027d6ad06e4a3f6062b2e
> core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html PRE-CREATION
> core/src/main/java/org/apache/accumulo/core/util/UnsynchronizedBuffer.java b640581bebbb87f1ac9a36f71275fa5dc8ef1223
>
> Diff: https://reviews.apache.org/r/15857/diff/
>
>
> Testing
> -------
>
> Compiled successfully; mvn javadoc:javadoc ran with no errors from the javadoc in this patch.
>
>
> Thanks,
>
> Bill Havanki
>
>
Re: Review Request 15857: ACCUMULO-1931 - Javadoc for core.data
Posted by Bill Havanki <bh...@clouderagovt.com>.
> On Dec. 6, 2013, 2:26 p.m., Sean Busbey wrote:
> > core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html, line 3
> > <https://reviews.apache.org/r/15857/diff/4/?file=393530#file393530line3>
> >
> > Just to verify, this html file will get included in the generated javadocs?
> >
> > Reading the javadoc plugin[1], it looks like maybe it needs to be in core/src/main/javadoc/org/apache/accumulo/core/data/doc-files/mutation-serialization.html
> >
> > [1]: http://maven.apache.org/plugins/maven-javadoc-plugin/examples/javadoc-resources.html
> >
It is. I'm using a capability of the javadoc tool itself[1] rather than the plugin. Interesting that there are multiple options for this.
[1]: http://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#unprocessed
> On Dec. 6, 2013, 2:26 p.m., Sean Busbey wrote:
> > core/src/main/java/org/apache/accumulo/core/data/Condition.java, lines 144-154
> > <https://reviews.apache.org/r/15857/diff/4/?file=393522#file393522line144>
> >
> > Should note that the value will be turned into UTF-8 bytes
Will do.
- Bill
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/15857/#review29897
-----------------------------------------------------------
On Dec. 3, 2013, 5:05 p.m., Bill Havanki wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/15857/
> -----------------------------------------------------------
>
> (Updated Dec. 3, 2013, 5:05 p.m.)
>
>
> Review request for accumulo.
>
>
> Bugs: ACCUMULO-1931
> https://issues.apache.org/jira/browse/ACCUMULO-1931
>
>
> Repository: accumulo
>
>
> Description
> -------
>
> Javadoc additions and updates to classes in org.apache.accumulo.core.data.
>
>
> Diffs
> -----
>
> core/src/main/java/org/apache/accumulo/core/data/ArrayByteSequence.java eaa61b9950b691ed5955af3178a3aa939291e8bf
> core/src/main/java/org/apache/accumulo/core/data/ByteSequence.java 4dc921c5efc44d374032c623f50e4218aa6c7299
> core/src/main/java/org/apache/accumulo/core/data/Column.java a56c01d6604a30153739ed1329d034e3932f2e2f
> core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java 641ca3a740ed384ab93f4b2d3c08c928daadfb2f
> core/src/main/java/org/apache/accumulo/core/data/ComparableBytes.java ce61844375617c36ede5e0e411b439205329b023
> core/src/main/java/org/apache/accumulo/core/data/Condition.java fc8f2bf0394ae658bacfa94804b4b81f19a0c0c2
> core/src/main/java/org/apache/accumulo/core/data/ConstraintViolationSummary.java 2929bc610df9352374621d29caea7732bd50847d
> core/src/main/java/org/apache/accumulo/core/data/Key.java de9e22d9ebff5442633dc578613fd7d033afc9c5
> core/src/main/java/org/apache/accumulo/core/data/KeyValue.java cc48322f9785ad508cc7925279f5e559629f3721
> core/src/main/java/org/apache/accumulo/core/data/Mutation.java 5e281f2bfef7e164c9f0e0c9a7132e94012d7186
> core/src/main/java/org/apache/accumulo/core/data/PartialKey.java 2049881fe26b5f237db39a412a88e2e2017f5cc9
> core/src/main/java/org/apache/accumulo/core/data/Range.java 70857348cefd0941e5ffcf6e5d569f09870101e4
> core/src/main/java/org/apache/accumulo/core/data/Value.java 7d3cf8f20aa12205d25027d6ad06e4a3f6062b2e
> core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html PRE-CREATION
> core/src/main/java/org/apache/accumulo/core/util/UnsynchronizedBuffer.java b640581bebbb87f1ac9a36f71275fa5dc8ef1223
>
> Diff: https://reviews.apache.org/r/15857/diff/
>
>
> Testing
> -------
>
> Compiled successfully; mvn javadoc:javadoc ran with no errors from the javadoc in this patch.
>
>
> Thanks,
>
> Bill Havanki
>
>
Re: Review Request 15857: ACCUMULO-1931 - Javadoc for core.data
Posted by Bill Havanki <bh...@clouderagovt.com>.
> On Dec. 6, 2013, 2:26 p.m., Sean Busbey wrote:
> > core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html, line 3
> > <https://reviews.apache.org/r/15857/diff/4/?file=393530#file393530line3>
> >
> > Just to verify, this html file will get included in the generated javadocs?
> >
> > Reading the javadoc plugin[1], it looks like maybe it needs to be in core/src/main/javadoc/org/apache/accumulo/core/data/doc-files/mutation-serialization.html
> >
> > [1]: http://maven.apache.org/plugins/maven-javadoc-plugin/examples/javadoc-resources.html
> >
>
> Bill Havanki wrote:
> It is. I'm using a capability of the javadoc tool itself[1] rather than the plugin. Interesting that there are multiple options for this.
>
> [1]: http://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#unprocessed
>
> Sean Busbey wrote:
> I saw that the javadoc tool will work with this location, just not sure if the javadoc Maven plugin changes the behavior. Might be worth moving it to src/main/javadoc to keep things more in line with "the Maven way."
(Adding comment that I had sent in email, sorry for the repetition)
It still works even under the Maven plugin, i.e., I checked by running mvn javadoc:javadoc and the file was transferred. So, leaving it where it is lets it work both with and without Maven.
- Bill
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/15857/#review29897
-----------------------------------------------------------
On Dec. 6, 2013, 2:56 p.m., Bill Havanki wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/15857/
> -----------------------------------------------------------
>
> (Updated Dec. 6, 2013, 2:56 p.m.)
>
>
> Review request for accumulo.
>
>
> Bugs: ACCUMULO-1931
> https://issues.apache.org/jira/browse/ACCUMULO-1931
>
>
> Repository: accumulo
>
>
> Description
> -------
>
> Javadoc additions and updates to classes in org.apache.accumulo.core.data.
>
>
> Diffs
> -----
>
> core/src/main/java/org/apache/accumulo/core/data/ArrayByteSequence.java eaa61b9950b691ed5955af3178a3aa939291e8bf
> core/src/main/java/org/apache/accumulo/core/data/ByteSequence.java 4dc921c5efc44d374032c623f50e4218aa6c7299
> core/src/main/java/org/apache/accumulo/core/data/Column.java a56c01d6604a30153739ed1329d034e3932f2e2f
> core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java 641ca3a740ed384ab93f4b2d3c08c928daadfb2f
> core/src/main/java/org/apache/accumulo/core/data/ComparableBytes.java ce61844375617c36ede5e0e411b439205329b023
> core/src/main/java/org/apache/accumulo/core/data/Condition.java fc8f2bf0394ae658bacfa94804b4b81f19a0c0c2
> core/src/main/java/org/apache/accumulo/core/data/ConstraintViolationSummary.java 2929bc610df9352374621d29caea7732bd50847d
> core/src/main/java/org/apache/accumulo/core/data/Key.java de9e22d9ebff5442633dc578613fd7d033afc9c5
> core/src/main/java/org/apache/accumulo/core/data/KeyValue.java cc48322f9785ad508cc7925279f5e559629f3721
> core/src/main/java/org/apache/accumulo/core/data/Mutation.java 5e281f2bfef7e164c9f0e0c9a7132e94012d7186
> core/src/main/java/org/apache/accumulo/core/data/PartialKey.java 2049881fe26b5f237db39a412a88e2e2017f5cc9
> core/src/main/java/org/apache/accumulo/core/data/Range.java 70857348cefd0941e5ffcf6e5d569f09870101e4
> core/src/main/java/org/apache/accumulo/core/data/Value.java 7d3cf8f20aa12205d25027d6ad06e4a3f6062b2e
> core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html PRE-CREATION
> core/src/main/java/org/apache/accumulo/core/util/UnsynchronizedBuffer.java b640581bebbb87f1ac9a36f71275fa5dc8ef1223
>
> Diff: https://reviews.apache.org/r/15857/diff/
>
>
> Testing
> -------
>
> Compiled successfully; mvn javadoc:javadoc ran with no errors from the javadoc in this patch.
>
>
> Thanks,
>
> Bill Havanki
>
>
Re: Review Request 15857: ACCUMULO-1931 - Javadoc for core.data
Posted by Sean Busbey <se...@manvsbeard.com>.
> On Dec. 6, 2013, 7:26 p.m., Sean Busbey wrote:
> > core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html, line 3
> > <https://reviews.apache.org/r/15857/diff/4/?file=393530#file393530line3>
> >
> > Just to verify, this html file will get included in the generated javadocs?
> >
> > Reading the javadoc plugin[1], it looks like maybe it needs to be in core/src/main/javadoc/org/apache/accumulo/core/data/doc-files/mutation-serialization.html
> >
> > [1]: http://maven.apache.org/plugins/maven-javadoc-plugin/examples/javadoc-resources.html
> >
>
> Bill Havanki wrote:
> It is. I'm using a capability of the javadoc tool itself[1] rather than the plugin. Interesting that there are multiple options for this.
>
> [1]: http://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#unprocessed
>
> Sean Busbey wrote:
> I saw that the javadoc tool will work with this location, just not sure if the javadoc Maven plugin changes the behavior. Might be worth moving it to src/main/javadoc to keep things more in line with "the Maven way."
>
> Bill Havanki wrote:
> (Adding comment that I had sent in email, sorry for the repetition)
>
> It still works even under the Maven plugin, i.e., I checked by running mvn javadoc:javadoc and the file was transferred. So, leaving it where it is lets it work both with and without Maven.
>
> Christopher Tubbs wrote:
> Why not use package-info.java, for package-level javadocs?
>
> Sean Busbey wrote:
> This particular file just provides an explanation of the Mutation serialization formats, it's not really package-level information. AFAICT, the only reason it's not going on the Mutation class directly is that there's too much to cover.
>
> Christopher Tubbs wrote:
> If it's too much to warrant inclusion on the Mutation class, and isn't appropriate at the package-level, then it seems to me that it should go in the user documentation, and shouldn't be part of the javadocs at all.
Are details of our internal serialization formats for the Mutation class appropriate for user facing documentation?
This seemed like a good fit for things people can use trying to develop within the Accumulo codebase. Reading the page, it's definitely more than I would normally put on the class, but definitely not something I would expose to users.
Do we use our Apache wiki space for developer docs yet? This is the sort of thing I'd expect to find there on other projects. The disadvantage of putting it there and linking is that those on isolated networks wouldn't be able to follow the link as they could in this case.
- Sean
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/15857/#review29897
-----------------------------------------------------------
On Dec. 6, 2013, 7:56 p.m., Bill Havanki wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/15857/
> -----------------------------------------------------------
>
> (Updated Dec. 6, 2013, 7:56 p.m.)
>
>
> Review request for accumulo.
>
>
> Bugs: ACCUMULO-1931
> https://issues.apache.org/jira/browse/ACCUMULO-1931
>
>
> Repository: accumulo
>
>
> Description
> -------
>
> Javadoc additions and updates to classes in org.apache.accumulo.core.data.
>
>
> Diffs
> -----
>
> core/src/main/java/org/apache/accumulo/core/data/ArrayByteSequence.java eaa61b9950b691ed5955af3178a3aa939291e8bf
> core/src/main/java/org/apache/accumulo/core/data/ByteSequence.java 4dc921c5efc44d374032c623f50e4218aa6c7299
> core/src/main/java/org/apache/accumulo/core/data/Column.java a56c01d6604a30153739ed1329d034e3932f2e2f
> core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java 641ca3a740ed384ab93f4b2d3c08c928daadfb2f
> core/src/main/java/org/apache/accumulo/core/data/ComparableBytes.java ce61844375617c36ede5e0e411b439205329b023
> core/src/main/java/org/apache/accumulo/core/data/Condition.java fc8f2bf0394ae658bacfa94804b4b81f19a0c0c2
> core/src/main/java/org/apache/accumulo/core/data/ConstraintViolationSummary.java 2929bc610df9352374621d29caea7732bd50847d
> core/src/main/java/org/apache/accumulo/core/data/Key.java de9e22d9ebff5442633dc578613fd7d033afc9c5
> core/src/main/java/org/apache/accumulo/core/data/KeyValue.java cc48322f9785ad508cc7925279f5e559629f3721
> core/src/main/java/org/apache/accumulo/core/data/Mutation.java 5e281f2bfef7e164c9f0e0c9a7132e94012d7186
> core/src/main/java/org/apache/accumulo/core/data/PartialKey.java 2049881fe26b5f237db39a412a88e2e2017f5cc9
> core/src/main/java/org/apache/accumulo/core/data/Range.java 70857348cefd0941e5ffcf6e5d569f09870101e4
> core/src/main/java/org/apache/accumulo/core/data/Value.java 7d3cf8f20aa12205d25027d6ad06e4a3f6062b2e
> core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html PRE-CREATION
> core/src/main/java/org/apache/accumulo/core/util/UnsynchronizedBuffer.java b640581bebbb87f1ac9a36f71275fa5dc8ef1223
>
> Diff: https://reviews.apache.org/r/15857/diff/
>
>
> Testing
> -------
>
> Compiled successfully; mvn javadoc:javadoc ran with no errors from the javadoc in this patch.
>
>
> Thanks,
>
> Bill Havanki
>
>
Re: Review Request 15857: ACCUMULO-1931 - Javadoc for core.data
Posted by Christopher Tubbs <ct...@apache.org>.
> On Dec. 6, 2013, 2:26 p.m., Sean Busbey wrote:
> > core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html, line 3
> > <https://reviews.apache.org/r/15857/diff/4/?file=393530#file393530line3>
> >
> > Just to verify, this html file will get included in the generated javadocs?
> >
> > Reading the javadoc plugin[1], it looks like maybe it needs to be in core/src/main/javadoc/org/apache/accumulo/core/data/doc-files/mutation-serialization.html
> >
> > [1]: http://maven.apache.org/plugins/maven-javadoc-plugin/examples/javadoc-resources.html
> >
>
> Bill Havanki wrote:
> It is. I'm using a capability of the javadoc tool itself[1] rather than the plugin. Interesting that there are multiple options for this.
>
> [1]: http://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#unprocessed
>
> Sean Busbey wrote:
> I saw that the javadoc tool will work with this location, just not sure if the javadoc Maven plugin changes the behavior. Might be worth moving it to src/main/javadoc to keep things more in line with "the Maven way."
>
> Bill Havanki wrote:
> (Adding comment that I had sent in email, sorry for the repetition)
>
> It still works even under the Maven plugin, i.e., I checked by running mvn javadoc:javadoc and the file was transferred. So, leaving it where it is lets it work both with and without Maven.
>
> Christopher Tubbs wrote:
> Why not use package-info.java, for package-level javadocs?
>
> Sean Busbey wrote:
> This particular file just provides an explanation of the Mutation serialization formats, it's not really package-level information. AFAICT, the only reason it's not going on the Mutation class directly is that there's too much to cover.
If it's too much to warrant inclusion on the Mutation class, and isn't appropriate at the package-level, then it seems to me that it should go in the user documentation, and shouldn't be part of the javadocs at all.
- Christopher
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/15857/#review29897
-----------------------------------------------------------
On Dec. 6, 2013, 2:56 p.m., Bill Havanki wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/15857/
> -----------------------------------------------------------
>
> (Updated Dec. 6, 2013, 2:56 p.m.)
>
>
> Review request for accumulo.
>
>
> Bugs: ACCUMULO-1931
> https://issues.apache.org/jira/browse/ACCUMULO-1931
>
>
> Repository: accumulo
>
>
> Description
> -------
>
> Javadoc additions and updates to classes in org.apache.accumulo.core.data.
>
>
> Diffs
> -----
>
> core/src/main/java/org/apache/accumulo/core/data/ArrayByteSequence.java eaa61b9950b691ed5955af3178a3aa939291e8bf
> core/src/main/java/org/apache/accumulo/core/data/ByteSequence.java 4dc921c5efc44d374032c623f50e4218aa6c7299
> core/src/main/java/org/apache/accumulo/core/data/Column.java a56c01d6604a30153739ed1329d034e3932f2e2f
> core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java 641ca3a740ed384ab93f4b2d3c08c928daadfb2f
> core/src/main/java/org/apache/accumulo/core/data/ComparableBytes.java ce61844375617c36ede5e0e411b439205329b023
> core/src/main/java/org/apache/accumulo/core/data/Condition.java fc8f2bf0394ae658bacfa94804b4b81f19a0c0c2
> core/src/main/java/org/apache/accumulo/core/data/ConstraintViolationSummary.java 2929bc610df9352374621d29caea7732bd50847d
> core/src/main/java/org/apache/accumulo/core/data/Key.java de9e22d9ebff5442633dc578613fd7d033afc9c5
> core/src/main/java/org/apache/accumulo/core/data/KeyValue.java cc48322f9785ad508cc7925279f5e559629f3721
> core/src/main/java/org/apache/accumulo/core/data/Mutation.java 5e281f2bfef7e164c9f0e0c9a7132e94012d7186
> core/src/main/java/org/apache/accumulo/core/data/PartialKey.java 2049881fe26b5f237db39a412a88e2e2017f5cc9
> core/src/main/java/org/apache/accumulo/core/data/Range.java 70857348cefd0941e5ffcf6e5d569f09870101e4
> core/src/main/java/org/apache/accumulo/core/data/Value.java 7d3cf8f20aa12205d25027d6ad06e4a3f6062b2e
> core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html PRE-CREATION
> core/src/main/java/org/apache/accumulo/core/util/UnsynchronizedBuffer.java b640581bebbb87f1ac9a36f71275fa5dc8ef1223
>
> Diff: https://reviews.apache.org/r/15857/diff/
>
>
> Testing
> -------
>
> Compiled successfully; mvn javadoc:javadoc ran with no errors from the javadoc in this patch.
>
>
> Thanks,
>
> Bill Havanki
>
>
Re: Review Request 15857: ACCUMULO-1931 - Javadoc for core.data
Posted by Bill Havanki <bh...@clouderagovt.com>.
> On Dec. 6, 2013, 2:26 p.m., Sean Busbey wrote:
> > core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html, line 3
> > <https://reviews.apache.org/r/15857/diff/4/?file=393530#file393530line3>
> >
> > Just to verify, this html file will get included in the generated javadocs?
> >
> > Reading the javadoc plugin[1], it looks like maybe it needs to be in core/src/main/javadoc/org/apache/accumulo/core/data/doc-files/mutation-serialization.html
> >
> > [1]: http://maven.apache.org/plugins/maven-javadoc-plugin/examples/javadoc-resources.html
> >
>
> Bill Havanki wrote:
> It is. I'm using a capability of the javadoc tool itself[1] rather than the plugin. Interesting that there are multiple options for this.
>
> [1]: http://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#unprocessed
>
> Sean Busbey wrote:
> I saw that the javadoc tool will work with this location, just not sure if the javadoc Maven plugin changes the behavior. Might be worth moving it to src/main/javadoc to keep things more in line with "the Maven way."
>
> Bill Havanki wrote:
> (Adding comment that I had sent in email, sorry for the repetition)
>
> It still works even under the Maven plugin, i.e., I checked by running mvn javadoc:javadoc and the file was transferred. So, leaving it where it is lets it work both with and without Maven.
>
> Christopher Tubbs wrote:
> Why not use package-info.java, for package-level javadocs?
>
> Sean Busbey wrote:
> This particular file just provides an explanation of the Mutation serialization formats, it's not really package-level information. AFAICT, the only reason it's not going on the Mutation class directly is that there's too much to cover.
>
> Christopher Tubbs wrote:
> If it's too much to warrant inclusion on the Mutation class, and isn't appropriate at the package-level, then it seems to me that it should go in the user documentation, and shouldn't be part of the javadocs at all.
>
> Sean Busbey wrote:
> Are details of our internal serialization formats for the Mutation class appropriate for user facing documentation?
>
> This seemed like a good fit for things people can use trying to develop within the Accumulo codebase. Reading the page, it's definitely more than I would normally put on the class, but definitely not something I would expose to users.
>
> Do we use our Apache wiki space for developer docs yet? This is the sort of thing I'd expect to find there on other projects. The disadvantage of putting it there and linking is that those on isolated networks wouldn't be able to follow the link as they could in this case.
Explaining my thinking: I created the separate doc because I did think it was too much for the Mutation class itself, as many people won't care about it. Also, since it only pertains to Mutation, putting it in the package overview seemed inappropriate.
Personally, I'm fine with wherever the proper eventual home for this should be. I know that we are thinking about consolidating docs (ACCUMULO-1490, for example). Creating this as a Javadoc at least has the current benefit of not introducing a new doc source. I wrote the doc in very plain HTML, knowing that it would most likely need to be moved and enhanced to some future permanent location. Sean's concern about "those on isolated networks" resonates with me as well.
- Bill
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/15857/#review29897
-----------------------------------------------------------
On Dec. 6, 2013, 2:56 p.m., Bill Havanki wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/15857/
> -----------------------------------------------------------
>
> (Updated Dec. 6, 2013, 2:56 p.m.)
>
>
> Review request for accumulo.
>
>
> Bugs: ACCUMULO-1931
> https://issues.apache.org/jira/browse/ACCUMULO-1931
>
>
> Repository: accumulo
>
>
> Description
> -------
>
> Javadoc additions and updates to classes in org.apache.accumulo.core.data.
>
>
> Diffs
> -----
>
> core/src/main/java/org/apache/accumulo/core/data/ArrayByteSequence.java eaa61b9950b691ed5955af3178a3aa939291e8bf
> core/src/main/java/org/apache/accumulo/core/data/ByteSequence.java 4dc921c5efc44d374032c623f50e4218aa6c7299
> core/src/main/java/org/apache/accumulo/core/data/Column.java a56c01d6604a30153739ed1329d034e3932f2e2f
> core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java 641ca3a740ed384ab93f4b2d3c08c928daadfb2f
> core/src/main/java/org/apache/accumulo/core/data/ComparableBytes.java ce61844375617c36ede5e0e411b439205329b023
> core/src/main/java/org/apache/accumulo/core/data/Condition.java fc8f2bf0394ae658bacfa94804b4b81f19a0c0c2
> core/src/main/java/org/apache/accumulo/core/data/ConstraintViolationSummary.java 2929bc610df9352374621d29caea7732bd50847d
> core/src/main/java/org/apache/accumulo/core/data/Key.java de9e22d9ebff5442633dc578613fd7d033afc9c5
> core/src/main/java/org/apache/accumulo/core/data/KeyValue.java cc48322f9785ad508cc7925279f5e559629f3721
> core/src/main/java/org/apache/accumulo/core/data/Mutation.java 5e281f2bfef7e164c9f0e0c9a7132e94012d7186
> core/src/main/java/org/apache/accumulo/core/data/PartialKey.java 2049881fe26b5f237db39a412a88e2e2017f5cc9
> core/src/main/java/org/apache/accumulo/core/data/Range.java 70857348cefd0941e5ffcf6e5d569f09870101e4
> core/src/main/java/org/apache/accumulo/core/data/Value.java 7d3cf8f20aa12205d25027d6ad06e4a3f6062b2e
> core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html PRE-CREATION
> core/src/main/java/org/apache/accumulo/core/util/UnsynchronizedBuffer.java b640581bebbb87f1ac9a36f71275fa5dc8ef1223
>
> Diff: https://reviews.apache.org/r/15857/diff/
>
>
> Testing
> -------
>
> Compiled successfully; mvn javadoc:javadoc ran with no errors from the javadoc in this patch.
>
>
> Thanks,
>
> Bill Havanki
>
>
Re: Review Request 15857: ACCUMULO-1931 - Javadoc for core.data
Posted by Bill Havanki <bh...@clouderagovt.com>.
It still works even under the Maven plugin, i.e., I checked by running mvn
javadoc:javadoc and the file was transferred. So, leaving it where it is
lets it work both with and without Maven.
On Fri, Dec 6, 2013 at 3:11 PM, Sean Busbey <se...@manvsbeard.com> wrote:
>
>
> > On Dec. 6, 2013, 7:26 p.m., Sean Busbey wrote:
> > >
> core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html,
> line 3
> > > <
> https://reviews.apache.org/r/15857/diff/4/?file=393530#file393530line3>
> > >
> > > Just to verify, this html file will get included in the generated
> javadocs?
> > >
> > > Reading the javadoc plugin[1], it looks like maybe it needs to be
> in
> core/src/main/javadoc/org/apache/accumulo/core/data/doc-files/mutation-serialization.html
> > >
> > > [1]:
> http://maven.apache.org/plugins/maven-javadoc-plugin/examples/javadoc-resources.html
> > >
> >
> > Bill Havanki wrote:
> > It is. I'm using a capability of the javadoc tool itself[1] rather
> than the plugin. Interesting that there are multiple options for this.
> >
> > [1]:
> http://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#unprocessed
>
> I saw that the javadoc tool will work with this location, just not sure if
> the javadoc Maven plugin changes the behavior. Might be worth moving it to
> src/main/javadoc to keep things more in line with "the Maven way."
>
>
> - Sean
>
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/15857/#review29897
> -----------------------------------------------------------
>
>
> On Dec. 6, 2013, 7:56 p.m., Bill Havanki wrote:
> >
> > -----------------------------------------------------------
> > This is an automatically generated e-mail. To reply, visit:
> > https://reviews.apache.org/r/15857/
> > -----------------------------------------------------------
> >
> > (Updated Dec. 6, 2013, 7:56 p.m.)
> >
> >
> > Review request for accumulo.
> >
> >
> > Bugs: ACCUMULO-1931
> > https://issues.apache.org/jira/browse/ACCUMULO-1931
> >
> >
> > Repository: accumulo
> >
> >
> > Description
> > -------
> >
> > Javadoc additions and updates to classes in
> org.apache.accumulo.core.data.
> >
> >
> > Diffs
> > -----
> >
> >
> core/src/main/java/org/apache/accumulo/core/data/ArrayByteSequence.java
> eaa61b9950b691ed5955af3178a3aa939291e8bf
> > core/src/main/java/org/apache/accumulo/core/data/ByteSequence.java
> 4dc921c5efc44d374032c623f50e4218aa6c7299
> > core/src/main/java/org/apache/accumulo/core/data/Column.java
> a56c01d6604a30153739ed1329d034e3932f2e2f
> > core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java
> 641ca3a740ed384ab93f4b2d3c08c928daadfb2f
> > core/src/main/java/org/apache/accumulo/core/data/ComparableBytes.java
> ce61844375617c36ede5e0e411b439205329b023
> > core/src/main/java/org/apache/accumulo/core/data/Condition.java
> fc8f2bf0394ae658bacfa94804b4b81f19a0c0c2
> >
> core/src/main/java/org/apache/accumulo/core/data/ConstraintViolationSummary.java
> 2929bc610df9352374621d29caea7732bd50847d
> > core/src/main/java/org/apache/accumulo/core/data/Key.java
> de9e22d9ebff5442633dc578613fd7d033afc9c5
> > core/src/main/java/org/apache/accumulo/core/data/KeyValue.java
> cc48322f9785ad508cc7925279f5e559629f3721
> > core/src/main/java/org/apache/accumulo/core/data/Mutation.java
> 5e281f2bfef7e164c9f0e0c9a7132e94012d7186
> > core/src/main/java/org/apache/accumulo/core/data/PartialKey.java
> 2049881fe26b5f237db39a412a88e2e2017f5cc9
> > core/src/main/java/org/apache/accumulo/core/data/Range.java
> 70857348cefd0941e5ffcf6e5d569f09870101e4
> > core/src/main/java/org/apache/accumulo/core/data/Value.java
> 7d3cf8f20aa12205d25027d6ad06e4a3f6062b2e
> >
> core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html
> PRE-CREATION
> >
> core/src/main/java/org/apache/accumulo/core/util/UnsynchronizedBuffer.java
> b640581bebbb87f1ac9a36f71275fa5dc8ef1223
> >
> > Diff: https://reviews.apache.org/r/15857/diff/
> >
> >
> > Testing
> > -------
> >
> > Compiled successfully; mvn javadoc:javadoc ran with no errors from the
> javadoc in this patch.
> >
> >
> > Thanks,
> >
> > Bill Havanki
> >
> >
>
>
--
| - - -
| Bill Havanki
| Solutions Architect, Cloudera Government Solutions
| - - -
Re: Review Request 15857: ACCUMULO-1931 - Javadoc for core.data
Posted by Sean Busbey <se...@manvsbeard.com>.
> On Dec. 6, 2013, 7:26 p.m., Sean Busbey wrote:
> > core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html, line 3
> > <https://reviews.apache.org/r/15857/diff/4/?file=393530#file393530line3>
> >
> > Just to verify, this html file will get included in the generated javadocs?
> >
> > Reading the javadoc plugin[1], it looks like maybe it needs to be in core/src/main/javadoc/org/apache/accumulo/core/data/doc-files/mutation-serialization.html
> >
> > [1]: http://maven.apache.org/plugins/maven-javadoc-plugin/examples/javadoc-resources.html
> >
>
> Bill Havanki wrote:
> It is. I'm using a capability of the javadoc tool itself[1] rather than the plugin. Interesting that there are multiple options for this.
>
> [1]: http://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#unprocessed
I saw that the javadoc tool will work with this location, just not sure if the javadoc Maven plugin changes the behavior. Might be worth moving it to src/main/javadoc to keep things more in line with "the Maven way."
- Sean
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/15857/#review29897
-----------------------------------------------------------
On Dec. 6, 2013, 7:56 p.m., Bill Havanki wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/15857/
> -----------------------------------------------------------
>
> (Updated Dec. 6, 2013, 7:56 p.m.)
>
>
> Review request for accumulo.
>
>
> Bugs: ACCUMULO-1931
> https://issues.apache.org/jira/browse/ACCUMULO-1931
>
>
> Repository: accumulo
>
>
> Description
> -------
>
> Javadoc additions and updates to classes in org.apache.accumulo.core.data.
>
>
> Diffs
> -----
>
> core/src/main/java/org/apache/accumulo/core/data/ArrayByteSequence.java eaa61b9950b691ed5955af3178a3aa939291e8bf
> core/src/main/java/org/apache/accumulo/core/data/ByteSequence.java 4dc921c5efc44d374032c623f50e4218aa6c7299
> core/src/main/java/org/apache/accumulo/core/data/Column.java a56c01d6604a30153739ed1329d034e3932f2e2f
> core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java 641ca3a740ed384ab93f4b2d3c08c928daadfb2f
> core/src/main/java/org/apache/accumulo/core/data/ComparableBytes.java ce61844375617c36ede5e0e411b439205329b023
> core/src/main/java/org/apache/accumulo/core/data/Condition.java fc8f2bf0394ae658bacfa94804b4b81f19a0c0c2
> core/src/main/java/org/apache/accumulo/core/data/ConstraintViolationSummary.java 2929bc610df9352374621d29caea7732bd50847d
> core/src/main/java/org/apache/accumulo/core/data/Key.java de9e22d9ebff5442633dc578613fd7d033afc9c5
> core/src/main/java/org/apache/accumulo/core/data/KeyValue.java cc48322f9785ad508cc7925279f5e559629f3721
> core/src/main/java/org/apache/accumulo/core/data/Mutation.java 5e281f2bfef7e164c9f0e0c9a7132e94012d7186
> core/src/main/java/org/apache/accumulo/core/data/PartialKey.java 2049881fe26b5f237db39a412a88e2e2017f5cc9
> core/src/main/java/org/apache/accumulo/core/data/Range.java 70857348cefd0941e5ffcf6e5d569f09870101e4
> core/src/main/java/org/apache/accumulo/core/data/Value.java 7d3cf8f20aa12205d25027d6ad06e4a3f6062b2e
> core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html PRE-CREATION
> core/src/main/java/org/apache/accumulo/core/util/UnsynchronizedBuffer.java b640581bebbb87f1ac9a36f71275fa5dc8ef1223
>
> Diff: https://reviews.apache.org/r/15857/diff/
>
>
> Testing
> -------
>
> Compiled successfully; mvn javadoc:javadoc ran with no errors from the javadoc in this patch.
>
>
> Thanks,
>
> Bill Havanki
>
>
Re: Review Request 15857: ACCUMULO-1931 - Javadoc for core.data
Posted by Sean Busbey <se...@manvsbeard.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/15857/#review29897
-----------------------------------------------------------
core/src/main/java/org/apache/accumulo/core/data/Condition.java
<https://reviews.apache.org/r/15857/#comment57363>
Should note that the value will be turned into UTF-8 bytes
core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html
<https://reviews.apache.org/r/15857/#comment57364>
Just to verify, this html file will get included in the generated javadocs?
Reading the javadoc plugin[1], it looks like maybe it needs to be in core/src/main/javadoc/org/apache/accumulo/core/data/doc-files/mutation-serialization.html
[1]: http://maven.apache.org/plugins/maven-javadoc-plugin/examples/javadoc-resources.html
- Sean Busbey
On Dec. 3, 2013, 10:05 p.m., Bill Havanki wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/15857/
> -----------------------------------------------------------
>
> (Updated Dec. 3, 2013, 10:05 p.m.)
>
>
> Review request for accumulo.
>
>
> Bugs: ACCUMULO-1931
> https://issues.apache.org/jira/browse/ACCUMULO-1931
>
>
> Repository: accumulo
>
>
> Description
> -------
>
> Javadoc additions and updates to classes in org.apache.accumulo.core.data.
>
>
> Diffs
> -----
>
> core/src/main/java/org/apache/accumulo/core/data/ArrayByteSequence.java eaa61b9950b691ed5955af3178a3aa939291e8bf
> core/src/main/java/org/apache/accumulo/core/data/ByteSequence.java 4dc921c5efc44d374032c623f50e4218aa6c7299
> core/src/main/java/org/apache/accumulo/core/data/Column.java a56c01d6604a30153739ed1329d034e3932f2e2f
> core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java 641ca3a740ed384ab93f4b2d3c08c928daadfb2f
> core/src/main/java/org/apache/accumulo/core/data/ComparableBytes.java ce61844375617c36ede5e0e411b439205329b023
> core/src/main/java/org/apache/accumulo/core/data/Condition.java fc8f2bf0394ae658bacfa94804b4b81f19a0c0c2
> core/src/main/java/org/apache/accumulo/core/data/ConstraintViolationSummary.java 2929bc610df9352374621d29caea7732bd50847d
> core/src/main/java/org/apache/accumulo/core/data/Key.java de9e22d9ebff5442633dc578613fd7d033afc9c5
> core/src/main/java/org/apache/accumulo/core/data/KeyValue.java cc48322f9785ad508cc7925279f5e559629f3721
> core/src/main/java/org/apache/accumulo/core/data/Mutation.java 5e281f2bfef7e164c9f0e0c9a7132e94012d7186
> core/src/main/java/org/apache/accumulo/core/data/PartialKey.java 2049881fe26b5f237db39a412a88e2e2017f5cc9
> core/src/main/java/org/apache/accumulo/core/data/Range.java 70857348cefd0941e5ffcf6e5d569f09870101e4
> core/src/main/java/org/apache/accumulo/core/data/Value.java 7d3cf8f20aa12205d25027d6ad06e4a3f6062b2e
> core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html PRE-CREATION
> core/src/main/java/org/apache/accumulo/core/util/UnsynchronizedBuffer.java b640581bebbb87f1ac9a36f71275fa5dc8ef1223
>
> Diff: https://reviews.apache.org/r/15857/diff/
>
>
> Testing
> -------
>
> Compiled successfully; mvn javadoc:javadoc ran with no errors from the javadoc in this patch.
>
>
> Thanks,
>
> Bill Havanki
>
>
Re: Review Request 15857: ACCUMULO-1931 - Javadoc for core.data
Posted by Bill Havanki <bh...@clouderagovt.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/15857/
-----------------------------------------------------------
(Updated Dec. 3, 2013, 5:05 p.m.)
Review request for accumulo.
Changes
-------
Added quick-and-dirty doc file for Mutation serialization formats.
Bugs: ACCUMULO-1931
https://issues.apache.org/jira/browse/ACCUMULO-1931
Repository: accumulo
Description
-------
Javadoc additions and updates to classes in org.apache.accumulo.core.data.
Diffs (updated)
-----
core/src/main/java/org/apache/accumulo/core/data/ArrayByteSequence.java eaa61b9950b691ed5955af3178a3aa939291e8bf
core/src/main/java/org/apache/accumulo/core/data/ByteSequence.java 4dc921c5efc44d374032c623f50e4218aa6c7299
core/src/main/java/org/apache/accumulo/core/data/Column.java a56c01d6604a30153739ed1329d034e3932f2e2f
core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java 641ca3a740ed384ab93f4b2d3c08c928daadfb2f
core/src/main/java/org/apache/accumulo/core/data/ComparableBytes.java ce61844375617c36ede5e0e411b439205329b023
core/src/main/java/org/apache/accumulo/core/data/Condition.java fc8f2bf0394ae658bacfa94804b4b81f19a0c0c2
core/src/main/java/org/apache/accumulo/core/data/ConstraintViolationSummary.java 2929bc610df9352374621d29caea7732bd50847d
core/src/main/java/org/apache/accumulo/core/data/Key.java de9e22d9ebff5442633dc578613fd7d033afc9c5
core/src/main/java/org/apache/accumulo/core/data/KeyValue.java cc48322f9785ad508cc7925279f5e559629f3721
core/src/main/java/org/apache/accumulo/core/data/Mutation.java 5e281f2bfef7e164c9f0e0c9a7132e94012d7186
core/src/main/java/org/apache/accumulo/core/data/PartialKey.java 2049881fe26b5f237db39a412a88e2e2017f5cc9
core/src/main/java/org/apache/accumulo/core/data/Range.java 70857348cefd0941e5ffcf6e5d569f09870101e4
core/src/main/java/org/apache/accumulo/core/data/Value.java 7d3cf8f20aa12205d25027d6ad06e4a3f6062b2e
core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html PRE-CREATION
core/src/main/java/org/apache/accumulo/core/util/UnsynchronizedBuffer.java b640581bebbb87f1ac9a36f71275fa5dc8ef1223
Diff: https://reviews.apache.org/r/15857/diff/
Testing
-------
Compiled successfully; mvn javadoc:javadoc ran with no errors from the javadoc in this patch.
Thanks,
Bill Havanki
Re: Review Request 15857: ACCUMULO-1931 - Javadoc for core.data
Posted by Bill Havanki <bh...@clouderagovt.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/15857/
-----------------------------------------------------------
(Updated Dec. 3, 2013, 2:13 p.m.)
Review request for accumulo.
Changes
-------
Incorporating numerous improvements from Keith's review.
Bugs: ACCUMULO-1931
https://issues.apache.org/jira/browse/ACCUMULO-1931
Repository: accumulo
Description
-------
Javadoc additions and updates to classes in org.apache.accumulo.core.data.
Diffs (updated)
-----
core/src/main/java/org/apache/accumulo/core/data/ArrayByteSequence.java eaa61b9950b691ed5955af3178a3aa939291e8bf
core/src/main/java/org/apache/accumulo/core/data/ByteSequence.java 4dc921c5efc44d374032c623f50e4218aa6c7299
core/src/main/java/org/apache/accumulo/core/data/Column.java a56c01d6604a30153739ed1329d034e3932f2e2f
core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java 641ca3a740ed384ab93f4b2d3c08c928daadfb2f
core/src/main/java/org/apache/accumulo/core/data/ComparableBytes.java ce61844375617c36ede5e0e411b439205329b023
core/src/main/java/org/apache/accumulo/core/data/Condition.java fc8f2bf0394ae658bacfa94804b4b81f19a0c0c2
core/src/main/java/org/apache/accumulo/core/data/ConstraintViolationSummary.java 2929bc610df9352374621d29caea7732bd50847d
core/src/main/java/org/apache/accumulo/core/data/Key.java de9e22d9ebff5442633dc578613fd7d033afc9c5
core/src/main/java/org/apache/accumulo/core/data/KeyValue.java cc48322f9785ad508cc7925279f5e559629f3721
core/src/main/java/org/apache/accumulo/core/data/Mutation.java 5e281f2bfef7e164c9f0e0c9a7132e94012d7186
core/src/main/java/org/apache/accumulo/core/data/PartialKey.java 2049881fe26b5f237db39a412a88e2e2017f5cc9
core/src/main/java/org/apache/accumulo/core/data/Range.java 70857348cefd0941e5ffcf6e5d569f09870101e4
core/src/main/java/org/apache/accumulo/core/data/Value.java 7d3cf8f20aa12205d25027d6ad06e4a3f6062b2e
core/src/main/java/org/apache/accumulo/core/util/UnsynchronizedBuffer.java b640581bebbb87f1ac9a36f71275fa5dc8ef1223
Diff: https://reviews.apache.org/r/15857/diff/
Testing
-------
Compiled successfully; mvn javadoc:javadoc ran with no errors from the javadoc in this patch.
Thanks,
Bill Havanki
Re: Review Request 15857: ACCUMULO-1931 - Javadoc for core.data
Posted by ke...@deenlo.com.
> On Dec. 3, 2013, 6:24 p.m., kturner wrote:
> > core/src/main/java/org/apache/accumulo/core/data/Mutation.java, line 609
> > <https://reviews.apache.org/r/15857/diff/2/?file=393088#file393088line609>
> >
> > Should mention that after this method is called a mutation can no longer be modfied. Also it does a defensive copy, changing the arrays pointed to by column update will not affect mutation
>
> Bill Havanki wrote:
> I'll add the needed verbiage, but the behavior you're describing isn't enforced by the class, i.e., you can still put things into a Mutation after calling getUpdates(), they just are (silently?) ignored. Perhaps that should be fixed?
I think it is, but I have not tried it. getUpdates() calls serialize which sets buffer to null. There is a put() method that checks if buffer is null and throws an exception.
- kturner
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/15857/#review29664
-----------------------------------------------------------
On Dec. 3, 2013, 7:13 p.m., Bill Havanki wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/15857/
> -----------------------------------------------------------
>
> (Updated Dec. 3, 2013, 7:13 p.m.)
>
>
> Review request for accumulo.
>
>
> Bugs: ACCUMULO-1931
> https://issues.apache.org/jira/browse/ACCUMULO-1931
>
>
> Repository: accumulo
>
>
> Description
> -------
>
> Javadoc additions and updates to classes in org.apache.accumulo.core.data.
>
>
> Diffs
> -----
>
> core/src/main/java/org/apache/accumulo/core/data/ArrayByteSequence.java eaa61b9950b691ed5955af3178a3aa939291e8bf
> core/src/main/java/org/apache/accumulo/core/data/ByteSequence.java 4dc921c5efc44d374032c623f50e4218aa6c7299
> core/src/main/java/org/apache/accumulo/core/data/Column.java a56c01d6604a30153739ed1329d034e3932f2e2f
> core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java 641ca3a740ed384ab93f4b2d3c08c928daadfb2f
> core/src/main/java/org/apache/accumulo/core/data/ComparableBytes.java ce61844375617c36ede5e0e411b439205329b023
> core/src/main/java/org/apache/accumulo/core/data/Condition.java fc8f2bf0394ae658bacfa94804b4b81f19a0c0c2
> core/src/main/java/org/apache/accumulo/core/data/ConstraintViolationSummary.java 2929bc610df9352374621d29caea7732bd50847d
> core/src/main/java/org/apache/accumulo/core/data/Key.java de9e22d9ebff5442633dc578613fd7d033afc9c5
> core/src/main/java/org/apache/accumulo/core/data/KeyValue.java cc48322f9785ad508cc7925279f5e559629f3721
> core/src/main/java/org/apache/accumulo/core/data/Mutation.java 5e281f2bfef7e164c9f0e0c9a7132e94012d7186
> core/src/main/java/org/apache/accumulo/core/data/PartialKey.java 2049881fe26b5f237db39a412a88e2e2017f5cc9
> core/src/main/java/org/apache/accumulo/core/data/Range.java 70857348cefd0941e5ffcf6e5d569f09870101e4
> core/src/main/java/org/apache/accumulo/core/data/Value.java 7d3cf8f20aa12205d25027d6ad06e4a3f6062b2e
> core/src/main/java/org/apache/accumulo/core/util/UnsynchronizedBuffer.java b640581bebbb87f1ac9a36f71275fa5dc8ef1223
>
> Diff: https://reviews.apache.org/r/15857/diff/
>
>
> Testing
> -------
>
> Compiled successfully; mvn javadoc:javadoc ran with no errors from the javadoc in this patch.
>
>
> Thanks,
>
> Bill Havanki
>
>
Re: Review Request 15857: ACCUMULO-1931 - Javadoc for core.data
Posted by Bill Havanki <bh...@clouderagovt.com>.
> On Dec. 3, 2013, 1:24 p.m., kturner wrote:
> > core/src/main/java/org/apache/accumulo/core/data/Mutation.java, line 251
> > <https://reviews.apache.org/r/15857/diff/2/?file=393088#file393088line251>
> >
> > should comment about defensive copy be here? or maybe in class javadoc for all put methods.
Added to each put() method.
> On Dec. 3, 2013, 1:24 p.m., kturner wrote:
> > core/src/main/java/org/apache/accumulo/core/data/Mutation.java, line 609
> > <https://reviews.apache.org/r/15857/diff/2/?file=393088#file393088line609>
> >
> > Should mention that after this method is called a mutation can no longer be modfied. Also it does a defensive copy, changing the arrays pointed to by column update will not affect mutation
I'll add the needed verbiage, but the behavior you're describing isn't enforced by the class, i.e., you can still put things into a Mutation after calling getUpdates(), they just are (silently?) ignored. Perhaps that should be fixed?
- Bill
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/15857/#review29664
-----------------------------------------------------------
On Dec. 3, 2013, 12:31 p.m., Bill Havanki wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/15857/
> -----------------------------------------------------------
>
> (Updated Dec. 3, 2013, 12:31 p.m.)
>
>
> Review request for accumulo.
>
>
> Bugs: ACCUMULO-1931
> https://issues.apache.org/jira/browse/ACCUMULO-1931
>
>
> Repository: accumulo
>
>
> Description
> -------
>
> Javadoc additions and updates to classes in org.apache.accumulo.core.data.
>
>
> Diffs
> -----
>
> core/src/main/java/org/apache/accumulo/core/data/ArrayByteSequence.java eaa61b9950b691ed5955af3178a3aa939291e8bf
> core/src/main/java/org/apache/accumulo/core/data/ByteSequence.java 4dc921c5efc44d374032c623f50e4218aa6c7299
> core/src/main/java/org/apache/accumulo/core/data/Column.java a56c01d6604a30153739ed1329d034e3932f2e2f
> core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java 641ca3a740ed384ab93f4b2d3c08c928daadfb2f
> core/src/main/java/org/apache/accumulo/core/data/ComparableBytes.java ce61844375617c36ede5e0e411b439205329b023
> core/src/main/java/org/apache/accumulo/core/data/Condition.java fc8f2bf0394ae658bacfa94804b4b81f19a0c0c2
> core/src/main/java/org/apache/accumulo/core/data/ConstraintViolationSummary.java 2929bc610df9352374621d29caea7732bd50847d
> core/src/main/java/org/apache/accumulo/core/data/Key.java de9e22d9ebff5442633dc578613fd7d033afc9c5
> core/src/main/java/org/apache/accumulo/core/data/KeyValue.java cc48322f9785ad508cc7925279f5e559629f3721
> core/src/main/java/org/apache/accumulo/core/data/Mutation.java 5e281f2bfef7e164c9f0e0c9a7132e94012d7186
> core/src/main/java/org/apache/accumulo/core/data/PartialKey.java 2049881fe26b5f237db39a412a88e2e2017f5cc9
> core/src/main/java/org/apache/accumulo/core/data/Range.java 70857348cefd0941e5ffcf6e5d569f09870101e4
> core/src/main/java/org/apache/accumulo/core/data/Value.java 7d3cf8f20aa12205d25027d6ad06e4a3f6062b2e
> core/src/main/java/org/apache/accumulo/core/util/UnsynchronizedBuffer.java b640581bebbb87f1ac9a36f71275fa5dc8ef1223
>
> Diff: https://reviews.apache.org/r/15857/diff/
>
>
> Testing
> -------
>
> Compiled successfully; mvn javadoc:javadoc ran with no errors from the javadoc in this patch.
>
>
> Thanks,
>
> Bill Havanki
>
>
Re: Review Request 15857: ACCUMULO-1931 - Javadoc for core.data
Posted by ke...@deenlo.com.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/15857/#review29664
-----------------------------------------------------------
core/src/main/java/org/apache/accumulo/core/data/Condition.java
<https://reviews.apache.org/r/15857/#comment57086>
might be worth mentioning utf8 here
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment57087>
nice, this comment about putDelete() was really needed
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment57088>
would be useful to indicate a copy is not made like you have in javadocs elsewhere
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment57089>
should comment about defensive copy be here? or maybe in class javadoc for all put methods.
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment57090>
Should mention that after this method is called a mutation can no longer be modfied. Also it does a defensive copy, changing the arrays pointed to by column update will not affect mutation
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment57091>
The estimate includes data size and Object overhead.
core/src/main/java/org/apache/accumulo/core/data/Range.java
<https://reviews.apache.org/r/15857/#comment57092>
s/throw/throwing/
Do you know if these changes introduce any javadoc warnings? In Eclipse I have turned on java doc warnings, but I did not pull the patch down and look.
- kturner
On Dec. 3, 2013, 5:31 p.m., Bill Havanki wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/15857/
> -----------------------------------------------------------
>
> (Updated Dec. 3, 2013, 5:31 p.m.)
>
>
> Review request for accumulo.
>
>
> Bugs: ACCUMULO-1931
> https://issues.apache.org/jira/browse/ACCUMULO-1931
>
>
> Repository: accumulo
>
>
> Description
> -------
>
> Javadoc additions and updates to classes in org.apache.accumulo.core.data.
>
>
> Diffs
> -----
>
> core/src/main/java/org/apache/accumulo/core/data/ArrayByteSequence.java eaa61b9950b691ed5955af3178a3aa939291e8bf
> core/src/main/java/org/apache/accumulo/core/data/ByteSequence.java 4dc921c5efc44d374032c623f50e4218aa6c7299
> core/src/main/java/org/apache/accumulo/core/data/Column.java a56c01d6604a30153739ed1329d034e3932f2e2f
> core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java 641ca3a740ed384ab93f4b2d3c08c928daadfb2f
> core/src/main/java/org/apache/accumulo/core/data/ComparableBytes.java ce61844375617c36ede5e0e411b439205329b023
> core/src/main/java/org/apache/accumulo/core/data/Condition.java fc8f2bf0394ae658bacfa94804b4b81f19a0c0c2
> core/src/main/java/org/apache/accumulo/core/data/ConstraintViolationSummary.java 2929bc610df9352374621d29caea7732bd50847d
> core/src/main/java/org/apache/accumulo/core/data/Key.java de9e22d9ebff5442633dc578613fd7d033afc9c5
> core/src/main/java/org/apache/accumulo/core/data/KeyValue.java cc48322f9785ad508cc7925279f5e559629f3721
> core/src/main/java/org/apache/accumulo/core/data/Mutation.java 5e281f2bfef7e164c9f0e0c9a7132e94012d7186
> core/src/main/java/org/apache/accumulo/core/data/PartialKey.java 2049881fe26b5f237db39a412a88e2e2017f5cc9
> core/src/main/java/org/apache/accumulo/core/data/Range.java 70857348cefd0941e5ffcf6e5d569f09870101e4
> core/src/main/java/org/apache/accumulo/core/data/Value.java 7d3cf8f20aa12205d25027d6ad06e4a3f6062b2e
> core/src/main/java/org/apache/accumulo/core/util/UnsynchronizedBuffer.java b640581bebbb87f1ac9a36f71275fa5dc8ef1223
>
> Diff: https://reviews.apache.org/r/15857/diff/
>
>
> Testing
> -------
>
> Compiled successfully; mvn javadoc:javadoc ran with no errors from the javadoc in this patch.
>
>
> Thanks,
>
> Bill Havanki
>
>
Re: Review Request 15857: ACCUMULO-1931 - Javadoc for core.data
Posted by Bill Havanki <bh...@clouderagovt.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/15857/
-----------------------------------------------------------
(Updated Dec. 3, 2013, 12:31 p.m.)
Review request for accumulo.
Changes
-------
Incorporating numerous improvements from Sean's review.
Bugs: ACCUMULO-1931
https://issues.apache.org/jira/browse/ACCUMULO-1931
Repository: accumulo
Description
-------
Javadoc additions and updates to classes in org.apache.accumulo.core.data.
Diffs (updated)
-----
core/src/main/java/org/apache/accumulo/core/data/ArrayByteSequence.java eaa61b9950b691ed5955af3178a3aa939291e8bf
core/src/main/java/org/apache/accumulo/core/data/ByteSequence.java 4dc921c5efc44d374032c623f50e4218aa6c7299
core/src/main/java/org/apache/accumulo/core/data/Column.java a56c01d6604a30153739ed1329d034e3932f2e2f
core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java 641ca3a740ed384ab93f4b2d3c08c928daadfb2f
core/src/main/java/org/apache/accumulo/core/data/ComparableBytes.java ce61844375617c36ede5e0e411b439205329b023
core/src/main/java/org/apache/accumulo/core/data/Condition.java fc8f2bf0394ae658bacfa94804b4b81f19a0c0c2
core/src/main/java/org/apache/accumulo/core/data/ConstraintViolationSummary.java 2929bc610df9352374621d29caea7732bd50847d
core/src/main/java/org/apache/accumulo/core/data/Key.java de9e22d9ebff5442633dc578613fd7d033afc9c5
core/src/main/java/org/apache/accumulo/core/data/KeyValue.java cc48322f9785ad508cc7925279f5e559629f3721
core/src/main/java/org/apache/accumulo/core/data/Mutation.java 5e281f2bfef7e164c9f0e0c9a7132e94012d7186
core/src/main/java/org/apache/accumulo/core/data/PartialKey.java 2049881fe26b5f237db39a412a88e2e2017f5cc9
core/src/main/java/org/apache/accumulo/core/data/Range.java 70857348cefd0941e5ffcf6e5d569f09870101e4
core/src/main/java/org/apache/accumulo/core/data/Value.java 7d3cf8f20aa12205d25027d6ad06e4a3f6062b2e
core/src/main/java/org/apache/accumulo/core/util/UnsynchronizedBuffer.java b640581bebbb87f1ac9a36f71275fa5dc8ef1223
Diff: https://reviews.apache.org/r/15857/diff/
Testing
-------
Compiled successfully; mvn javadoc:javadoc ran with no errors from the javadoc in this patch.
Thanks,
Bill Havanki
Re: Review Request 15857: ACCUMULO-1931 - Javadoc for core.data
Posted by Bill Havanki <bh...@clouderagovt.com>.
> On Nov. 27, 2013, 3:43 a.m., Sean Busbey wrote:
> > core/src/main/java/org/apache/accumulo/core/data/Range.java, lines 179-190
> > <https://reviews.apache.org/r/15857/diff/1/?file=391177#file391177line179>
> >
> > Are we sure this constructor purposefully allows the end key to be before the start key?
> >
> > including it in the javadocs here makes it expected behavior for the future, rather than a potential bug.
>
> Bill Havanki wrote:
> I dropped mention of this method permitting end key < start key. This constructor appears unused (outside Range, anyway), and so I think we should open a JIRA to either remove it or fix it.
Filed ACCUMULO-1958 to address this. I'll call this issue fixed since I omitted the questionable verbiage.
- Bill
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/15857/#review29477
-----------------------------------------------------------
On Dec. 3, 2013, 5:05 p.m., Bill Havanki wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/15857/
> -----------------------------------------------------------
>
> (Updated Dec. 3, 2013, 5:05 p.m.)
>
>
> Review request for accumulo.
>
>
> Bugs: ACCUMULO-1931
> https://issues.apache.org/jira/browse/ACCUMULO-1931
>
>
> Repository: accumulo
>
>
> Description
> -------
>
> Javadoc additions and updates to classes in org.apache.accumulo.core.data.
>
>
> Diffs
> -----
>
> core/src/main/java/org/apache/accumulo/core/data/ArrayByteSequence.java eaa61b9950b691ed5955af3178a3aa939291e8bf
> core/src/main/java/org/apache/accumulo/core/data/ByteSequence.java 4dc921c5efc44d374032c623f50e4218aa6c7299
> core/src/main/java/org/apache/accumulo/core/data/Column.java a56c01d6604a30153739ed1329d034e3932f2e2f
> core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java 641ca3a740ed384ab93f4b2d3c08c928daadfb2f
> core/src/main/java/org/apache/accumulo/core/data/ComparableBytes.java ce61844375617c36ede5e0e411b439205329b023
> core/src/main/java/org/apache/accumulo/core/data/Condition.java fc8f2bf0394ae658bacfa94804b4b81f19a0c0c2
> core/src/main/java/org/apache/accumulo/core/data/ConstraintViolationSummary.java 2929bc610df9352374621d29caea7732bd50847d
> core/src/main/java/org/apache/accumulo/core/data/Key.java de9e22d9ebff5442633dc578613fd7d033afc9c5
> core/src/main/java/org/apache/accumulo/core/data/KeyValue.java cc48322f9785ad508cc7925279f5e559629f3721
> core/src/main/java/org/apache/accumulo/core/data/Mutation.java 5e281f2bfef7e164c9f0e0c9a7132e94012d7186
> core/src/main/java/org/apache/accumulo/core/data/PartialKey.java 2049881fe26b5f237db39a412a88e2e2017f5cc9
> core/src/main/java/org/apache/accumulo/core/data/Range.java 70857348cefd0941e5ffcf6e5d569f09870101e4
> core/src/main/java/org/apache/accumulo/core/data/Value.java 7d3cf8f20aa12205d25027d6ad06e4a3f6062b2e
> core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html PRE-CREATION
> core/src/main/java/org/apache/accumulo/core/util/UnsynchronizedBuffer.java b640581bebbb87f1ac9a36f71275fa5dc8ef1223
>
> Diff: https://reviews.apache.org/r/15857/diff/
>
>
> Testing
> -------
>
> Compiled successfully; mvn javadoc:javadoc ran with no errors from the javadoc in this patch.
>
>
> Thanks,
>
> Bill Havanki
>
>
Re: Review Request 15857: ACCUMULO-1931 - Javadoc for core.data
Posted by Bill Havanki <bh...@clouderagovt.com>.
> On Nov. 27, 2013, 3:43 a.m., Sean Busbey wrote:
> > core/src/main/java/org/apache/accumulo/core/data/Mutation.java, lines 64-66
> > <https://reviews.apache.org/r/15857/diff/1/?file=391175#file391175line64>
> >
> > Any chance for @since markers on these versions, or a pointer here to their details / differences?
>
> Bill Havanki wrote:
> The enum was introduced in Accumulo 1.5 with both values, so @since won't be helpful. I will need to look for docs on the differences, or maybe note it here.
I put together a doc on the serialization formats and included a link to it. See diff 4 of this review.
- Bill
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/15857/#review29477
-----------------------------------------------------------
On Dec. 3, 2013, 5:05 p.m., Bill Havanki wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/15857/
> -----------------------------------------------------------
>
> (Updated Dec. 3, 2013, 5:05 p.m.)
>
>
> Review request for accumulo.
>
>
> Bugs: ACCUMULO-1931
> https://issues.apache.org/jira/browse/ACCUMULO-1931
>
>
> Repository: accumulo
>
>
> Description
> -------
>
> Javadoc additions and updates to classes in org.apache.accumulo.core.data.
>
>
> Diffs
> -----
>
> core/src/main/java/org/apache/accumulo/core/data/ArrayByteSequence.java eaa61b9950b691ed5955af3178a3aa939291e8bf
> core/src/main/java/org/apache/accumulo/core/data/ByteSequence.java 4dc921c5efc44d374032c623f50e4218aa6c7299
> core/src/main/java/org/apache/accumulo/core/data/Column.java a56c01d6604a30153739ed1329d034e3932f2e2f
> core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java 641ca3a740ed384ab93f4b2d3c08c928daadfb2f
> core/src/main/java/org/apache/accumulo/core/data/ComparableBytes.java ce61844375617c36ede5e0e411b439205329b023
> core/src/main/java/org/apache/accumulo/core/data/Condition.java fc8f2bf0394ae658bacfa94804b4b81f19a0c0c2
> core/src/main/java/org/apache/accumulo/core/data/ConstraintViolationSummary.java 2929bc610df9352374621d29caea7732bd50847d
> core/src/main/java/org/apache/accumulo/core/data/Key.java de9e22d9ebff5442633dc578613fd7d033afc9c5
> core/src/main/java/org/apache/accumulo/core/data/KeyValue.java cc48322f9785ad508cc7925279f5e559629f3721
> core/src/main/java/org/apache/accumulo/core/data/Mutation.java 5e281f2bfef7e164c9f0e0c9a7132e94012d7186
> core/src/main/java/org/apache/accumulo/core/data/PartialKey.java 2049881fe26b5f237db39a412a88e2e2017f5cc9
> core/src/main/java/org/apache/accumulo/core/data/Range.java 70857348cefd0941e5ffcf6e5d569f09870101e4
> core/src/main/java/org/apache/accumulo/core/data/Value.java 7d3cf8f20aa12205d25027d6ad06e4a3f6062b2e
> core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html PRE-CREATION
> core/src/main/java/org/apache/accumulo/core/util/UnsynchronizedBuffer.java b640581bebbb87f1ac9a36f71275fa5dc8ef1223
>
> Diff: https://reviews.apache.org/r/15857/diff/
>
>
> Testing
> -------
>
> Compiled successfully; mvn javadoc:javadoc ran with no errors from the javadoc in this patch.
>
>
> Thanks,
>
> Bill Havanki
>
>
Re: Review Request 15857: ACCUMULO-1931 - Javadoc for core.data
Posted by Bill Havanki <bh...@clouderagovt.com>.
> On Nov. 27, 2013, 3:43 a.m., Sean Busbey wrote:
> > core/src/main/java/org/apache/accumulo/core/data/Column.java, lines 179-183
> > <https://reviews.apache.org/r/15857/diff/1/?file=391168#file391168line179>
> >
> > worth noting that the member is passed back directly and is thus modifiable by the caller?
Noted.
> On Nov. 27, 2013, 3:43 a.m., Sean Busbey wrote:
> > core/src/main/java/org/apache/accumulo/core/data/Column.java, lines 188-192
> > <https://reviews.apache.org/r/15857/diff/1/?file=391168#file391168line188>
> >
> > worth noting that the member is passed back directly and is thus modifiable by the caller?
Noted.
> On Nov. 27, 2013, 3:43 a.m., Sean Busbey wrote:
> > core/src/main/java/org/apache/accumulo/core/data/Column.java, lines 197-201
> > <https://reviews.apache.org/r/15857/diff/1/?file=391168#file391168line197>
> >
> > worth noting that the member is passed back directly and is thus modifiable by the caller?
Noted.
> On Nov. 27, 2013, 3:43 a.m., Sean Busbey wrote:
> > core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java, lines 75-79
> > <https://reviews.apache.org/r/15857/diff/1/?file=391169#file391169line75>
> >
> > worth noting that the member is passed back directly and is thus modifiable by the caller?
Noted.
> On Nov. 27, 2013, 3:43 a.m., Sean Busbey wrote:
> > core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java, lines 84-88
> > <https://reviews.apache.org/r/15857/diff/1/?file=391169#file391169line84>
> >
> > worth noting that the member is passed back directly and is thus modifiable by the caller?
Noted.
> On Nov. 27, 2013, 3:43 a.m., Sean Busbey wrote:
> > core/src/main/java/org/apache/accumulo/core/data/Mutation.java, lines 50-51
> > <https://reviews.apache.org/r/15857/diff/1/?file=391175#file391175line50>
> >
> > Worth noting that a delete marker will hide any entries for that row column with an earlier timestamp? And that Accumulo will eventually remove said data from disk as a part of normal garbage collection?
Noted.
> On Nov. 27, 2013, 3:43 a.m., Sean Busbey wrote:
> > core/src/main/java/org/apache/accumulo/core/data/Mutation.java, lines 64-66
> > <https://reviews.apache.org/r/15857/diff/1/?file=391175#file391175line64>
> >
> > Any chance for @since markers on these versions, or a pointer here to their details / differences?
The enum was introduced in Accumulo 1.5 with both values, so @since won't be helpful. I will need to look for docs on the differences, or maybe note it here.
> On Nov. 27, 2013, 3:43 a.m., Sean Busbey wrote:
> > core/src/main/java/org/apache/accumulo/core/data/Range.java, lines 179-190
> > <https://reviews.apache.org/r/15857/diff/1/?file=391177#file391177line179>
> >
> > Are we sure this constructor purposefully allows the end key to be before the start key?
> >
> > including it in the javadocs here makes it expected behavior for the future, rather than a potential bug.
I dropped mention of this method permitting end key < start key. This constructor appears unused (outside Range, anyway), and so I think we should open a JIRA to either remove it or fix it.
> On Nov. 27, 2013, 3:43 a.m., Sean Busbey wrote:
> > core/src/main/java/org/apache/accumulo/core/data/Value.java, lines 78-79
> > <https://reviews.apache.org/r/15857/diff/1/?file=391178#file391178line78>
> >
> > Maybe the above should say the copy flag can indicate that the caller wants to force a copy?
> >
> > then this comment could be a TODO to indicate that toBytes means we always copy at least once, and twice when copy is true?
Doing a double copy doesn't make any sense to me. The Javadoc I have is my closest interpretation to what the interface means, regardless of what it does. I'm going to file a JIRA about this one for further investigation.
- Bill
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/15857/#review29477
-----------------------------------------------------------
On Nov. 26, 2013, 1:13 p.m., Bill Havanki wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/15857/
> -----------------------------------------------------------
>
> (Updated Nov. 26, 2013, 1:13 p.m.)
>
>
> Review request for accumulo.
>
>
> Bugs: ACCUMULO-1931
> https://issues.apache.org/jira/browse/ACCUMULO-1931
>
>
> Repository: accumulo
>
>
> Description
> -------
>
> Javadoc additions and updates to classes in org.apache.accumulo.core.data.
>
>
> Diffs
> -----
>
> core/src/main/java/org/apache/accumulo/core/data/ArrayByteSequence.java eaa61b9950b691ed5955af3178a3aa939291e8bf
> core/src/main/java/org/apache/accumulo/core/data/ByteSequence.java 4dc921c5efc44d374032c623f50e4218aa6c7299
> core/src/main/java/org/apache/accumulo/core/data/Column.java a56c01d6604a30153739ed1329d034e3932f2e2f
> core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java 641ca3a740ed384ab93f4b2d3c08c928daadfb2f
> core/src/main/java/org/apache/accumulo/core/data/ComparableBytes.java ce61844375617c36ede5e0e411b439205329b023
> core/src/main/java/org/apache/accumulo/core/data/Condition.java fc8f2bf0394ae658bacfa94804b4b81f19a0c0c2
> core/src/main/java/org/apache/accumulo/core/data/ConstraintViolationSummary.java 2929bc610df9352374621d29caea7732bd50847d
> core/src/main/java/org/apache/accumulo/core/data/Key.java de9e22d9ebff5442633dc578613fd7d033afc9c5
> core/src/main/java/org/apache/accumulo/core/data/KeyValue.java cc48322f9785ad508cc7925279f5e559629f3721
> core/src/main/java/org/apache/accumulo/core/data/Mutation.java 5e281f2bfef7e164c9f0e0c9a7132e94012d7186
> core/src/main/java/org/apache/accumulo/core/data/PartialKey.java 2049881fe26b5f237db39a412a88e2e2017f5cc9
> core/src/main/java/org/apache/accumulo/core/data/Range.java 70857348cefd0941e5ffcf6e5d569f09870101e4
> core/src/main/java/org/apache/accumulo/core/data/Value.java 7d3cf8f20aa12205d25027d6ad06e4a3f6062b2e
> core/src/main/java/org/apache/accumulo/core/util/UnsynchronizedBuffer.java b640581bebbb87f1ac9a36f71275fa5dc8ef1223
>
> Diff: https://reviews.apache.org/r/15857/diff/
>
>
> Testing
> -------
>
> Compiled successfully; mvn javadoc:javadoc ran with no errors from the javadoc in this patch.
>
>
> Thanks,
>
> Bill Havanki
>
>
Re: Review Request 15857: ACCUMULO-1931 - Javadoc for core.data
Posted by Sean Busbey <se...@manvsbeard.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/15857/#review29477
-----------------------------------------------------------
core/src/main/java/org/apache/accumulo/core/data/ArrayByteSequence.java
<https://reviews.apache.org/r/15857/#comment56714>
s/invalide/invalid
Actually "out of bounds for the given byte array" would be clearer.
core/src/main/java/org/apache/accumulo/core/data/ArrayByteSequence.java
<https://reviews.apache.org/r/15857/#comment56715>
This is not quite correct. If there isn't a backing array, the function does a relative bulk get for all remaining bytes in the buffer.
It won't get bytes in the buffer from before the current position, nor after the current limit.
core/src/main/java/org/apache/accumulo/core/data/Column.java
<https://reviews.apache.org/r/15857/#comment56716>
worth noting that the member is passed back directly and is thus modifiable by the caller?
core/src/main/java/org/apache/accumulo/core/data/Column.java
<https://reviews.apache.org/r/15857/#comment56717>
worth noting that the member is passed back directly and is thus modifiable by the caller?
core/src/main/java/org/apache/accumulo/core/data/Column.java
<https://reviews.apache.org/r/15857/#comment56718>
worth noting that the member is passed back directly and is thus modifiable by the caller?
core/src/main/java/org/apache/accumulo/core/data/Column.java
<https://reviews.apache.org/r/15857/#comment56719>
and nulls are treated as empty strings.
core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java
<https://reviews.apache.org/r/15857/#comment56720>
worth noting that the member is passed back directly and is thus modifiable by the caller?
core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java
<https://reviews.apache.org/r/15857/#comment56721>
worth noting that the member is passed back directly and is thus modifiable by the caller?
core/src/main/java/org/apache/accumulo/core/data/Condition.java
<https://reviews.apache.org/r/15857/#comment56725>
visibility is set to an empty byte array, not null.
core/src/main/java/org/apache/accumulo/core/data/Condition.java
<https://reviews.apache.org/r/15857/#comment56726>
visibility is set to an empty byte array, not null.
core/src/main/java/org/apache/accumulo/core/data/Condition.java
<https://reviews.apache.org/r/15857/#comment56727>
visibility is set to an empty byte array, not null.
core/src/main/java/org/apache/accumulo/core/data/Condition.java
<https://reviews.apache.org/r/15857/#comment56728>
visibility is set to an empty byte array, not null.
core/src/main/java/org/apache/accumulo/core/data/Condition.java
<https://reviews.apache.org/r/15857/#comment56729>
s/Inorder/In order
core/src/main/java/org/apache/accumulo/core/data/Condition.java
<https://reviews.apache.org/r/15857/#comment56730>
s/Inorder/In order
core/src/main/java/org/apache/accumulo/core/data/Condition.java
<https://reviews.apache.org/r/15857/#comment56731>
s/Inorder/In order
core/src/main/java/org/apache/accumulo/core/data/Condition.java
<https://reviews.apache.org/r/15857/#comment56732>
s/Inorder/In order
core/src/main/java/org/apache/accumulo/core/data/Key.java
<https://reviews.apache.org/r/15857/#comment56733>
worth pointing out that it's printable when considering the byte array as ASCII.
core/src/main/java/org/apache/accumulo/core/data/Key.java
<https://reviews.apache.org/r/15857/#comment56734>
worth pointing out that it's printable when considering the byte array as ASCII.
core/src/main/java/org/apache/accumulo/core/data/Key.java
<https://reviews.apache.org/r/15857/#comment56736>
worth pointing out that it's turning it into a string when considering the bytes as ASCII.
also a pointer to the caveats on appendPrintableString?
core/src/main/java/org/apache/accumulo/core/data/Key.java
<https://reviews.apache.org/r/15857/#comment56735>
s/coliumn/column
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment56761>
Worth noting that a delete marker will hide any entries for that row column with an earlier timestamp? And that Accumulo will eventually remove said data from disk as a part of normal garbage collection?
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment56737>
Any chance for @since markers on these versions, or a pointer here to their details / differences?
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment56738>
note that the buffer will be copied?
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment56739>
note that the buffer will be copied?
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment56740>
note that the Text contents will be copied?
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment56741>
will have an empty visibility string.
will have a timestamp set when received by a tablet server
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment56743>
will have a timestamp set when received by a tablet server
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment56742>
will have an empty visibility string
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment56744>
will only match an empty visibility string.
will have a timestamp set when received by a tablet server
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment56745>
will have a timestamp set when received by a tablet server
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment56746>
will only match an empty visibility string.
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment56747>
will have an empty visibility string.
will have a timestamp set when received by a tablet server
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment56748>
will have a timestamp set when received by a tablet server
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment56749>
will have an empty visibility string.
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment56750>
will only match an empty visibility string.
will have a timestamp set when received by a tablet server
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment56751>
will have a timestamp set when received by a tablet server
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment56752>
will only match an empty visibility string.
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment56753>
will have an empty visibility string.
will have a timestamp set when received by a tablet server
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment56754>
will have an empty visibility string.
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment56755>
will have an empty visibility string.
will have a timestamp set when received by a tablet server
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment56756>
will have a timestamp set when received by a tablet server
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment56757>
will have an empty visibility string.
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment56758>
will only match an empty visibility string.
will have a timestamp set when received by a tablet server
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment56759>
will have a timestamp set when received by a tablet server
core/src/main/java/org/apache/accumulo/core/data/Mutation.java
<https://reviews.apache.org/r/15857/#comment56760>
will have an empty visibility string.
core/src/main/java/org/apache/accumulo/core/data/Range.java
<https://reviews.apache.org/r/15857/#comment56762>
Are we sure this constructor purposefully allows the end key to be before the start key?
including it in the javadocs here makes it expected behavior for the future, rather than a potential bug.
core/src/main/java/org/apache/accumulo/core/data/Range.java
<https://reviews.apache.org/r/15857/#comment56763>
this method can optionally return null if the ranges do not overlap, instead of throwing an exception. The returnNullIfDisjoint parameter controls this behavior.
core/src/main/java/org/apache/accumulo/core/data/Value.java
<https://reviews.apache.org/r/15857/#comment56764>
Include a note about copying or not?
core/src/main/java/org/apache/accumulo/core/data/Value.java
<https://reviews.apache.org/r/15857/#comment56765>
Maybe the above should say the copy flag can indicate that the caller wants to force a copy?
then this comment could be a TODO to indicate that toBytes means we always copy at least once, and twice when copy is true?
core/src/main/java/org/apache/accumulo/core/util/UnsynchronizedBuffer.java
<https://reviews.apache.org/r/15857/#comment56766>
Should note what the variable-length encoding is. AFAICT, this is just a reimplementaiton of o.a.h.io.WritableUtils.writeVInt to work with the underlying buffer.
Could copy/paste description from there or link to it.
core/src/main/java/org/apache/accumulo/core/util/UnsynchronizedBuffer.java
<https://reviews.apache.org/r/15857/#comment56767>
Should note what the variable-length encoding is. AFAICT, this is just a reimplementaiton of o.a.h.io.WritableUtils.writeVLong to work with the underlying buffer.
Could copy/paste description from there or link to it.
- Sean Busbey
On Nov. 26, 2013, 6:13 p.m., Bill Havanki wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/15857/
> -----------------------------------------------------------
>
> (Updated Nov. 26, 2013, 6:13 p.m.)
>
>
> Review request for accumulo.
>
>
> Bugs: ACCUMULO-1931
> https://issues.apache.org/jira/browse/ACCUMULO-1931
>
>
> Repository: accumulo
>
>
> Description
> -------
>
> Javadoc additions and updates to classes in org.apache.accumulo.core.data.
>
>
> Diffs
> -----
>
> core/src/main/java/org/apache/accumulo/core/data/ArrayByteSequence.java eaa61b9950b691ed5955af3178a3aa939291e8bf
> core/src/main/java/org/apache/accumulo/core/data/ByteSequence.java 4dc921c5efc44d374032c623f50e4218aa6c7299
> core/src/main/java/org/apache/accumulo/core/data/Column.java a56c01d6604a30153739ed1329d034e3932f2e2f
> core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java 641ca3a740ed384ab93f4b2d3c08c928daadfb2f
> core/src/main/java/org/apache/accumulo/core/data/ComparableBytes.java ce61844375617c36ede5e0e411b439205329b023
> core/src/main/java/org/apache/accumulo/core/data/Condition.java fc8f2bf0394ae658bacfa94804b4b81f19a0c0c2
> core/src/main/java/org/apache/accumulo/core/data/ConstraintViolationSummary.java 2929bc610df9352374621d29caea7732bd50847d
> core/src/main/java/org/apache/accumulo/core/data/Key.java de9e22d9ebff5442633dc578613fd7d033afc9c5
> core/src/main/java/org/apache/accumulo/core/data/KeyValue.java cc48322f9785ad508cc7925279f5e559629f3721
> core/src/main/java/org/apache/accumulo/core/data/Mutation.java 5e281f2bfef7e164c9f0e0c9a7132e94012d7186
> core/src/main/java/org/apache/accumulo/core/data/PartialKey.java 2049881fe26b5f237db39a412a88e2e2017f5cc9
> core/src/main/java/org/apache/accumulo/core/data/Range.java 70857348cefd0941e5ffcf6e5d569f09870101e4
> core/src/main/java/org/apache/accumulo/core/data/Value.java 7d3cf8f20aa12205d25027d6ad06e4a3f6062b2e
> core/src/main/java/org/apache/accumulo/core/util/UnsynchronizedBuffer.java b640581bebbb87f1ac9a36f71275fa5dc8ef1223
>
> Diff: https://reviews.apache.org/r/15857/diff/
>
>
> Testing
> -------
>
> Compiled successfully; mvn javadoc:javadoc ran with no errors from the javadoc in this patch.
>
>
> Thanks,
>
> Bill Havanki
>
>