mirror of
https://github.com/nosqlbench/nosqlbench.git
synced 2025-02-25 18:55:28 -06:00
docs improvements
This commit is contained in:
parent
5e6a7f37c9
commit
74fab227a0
@ -14,16 +14,7 @@ import java.util.function.LongFunction;
|
|||||||
* Takes an input as a reference point in epoch time, and converts it to a DateRange,
|
* Takes an input as a reference point in epoch time, and converts it to a DateRange,
|
||||||
* with the bounds set to the lower and upper timestamps which align to the
|
* with the bounds set to the lower and upper timestamps which align to the
|
||||||
* specified precision. You can use any of these precisions to control the bounds
|
* specified precision. You can use any of these precisions to control the bounds
|
||||||
* around the provided timestamp:
|
* around the provided timestamp: millisecond, second, minute, hour, day, month, or year.
|
||||||
* <ul>
|
|
||||||
* <LI>millisecond</LI>
|
|
||||||
* <LI>second</LI>
|
|
||||||
* <LI>minute</LI>
|
|
||||||
* <LI>hour</LI>
|
|
||||||
* <li>day</li>
|
|
||||||
* <li>month</li>
|
|
||||||
* <li>year</li>
|
|
||||||
* </ul>
|
|
||||||
*/
|
*/
|
||||||
@ThreadSafeMapper
|
@ThreadSafeMapper
|
||||||
@Categories(Category.datetime)
|
@Categories(Category.datetime)
|
||||||
|
@ -14,16 +14,7 @@ import java.util.function.LongUnaryOperator;
|
|||||||
/**
|
/**
|
||||||
* Uses the precision and the two functions provided to create a DateRange.
|
* Uses the precision and the two functions provided to create a DateRange.
|
||||||
* You can use any of these precisions to control the bounds
|
* You can use any of these precisions to control the bounds
|
||||||
* around the provided timestamp:
|
* around the provided timestamp: millisecond, second, minute, hour, day, month, or year.
|
||||||
* <ul>
|
|
||||||
* <LI>millisecond</LI>
|
|
||||||
* <LI>second</LI>
|
|
||||||
* <LI>minute</LI>
|
|
||||||
* <LI>hour</LI>
|
|
||||||
* <li>day</li>
|
|
||||||
* <li>month</li>
|
|
||||||
* <li>year</li>
|
|
||||||
* </ul>
|
|
||||||
*/
|
*/
|
||||||
@ThreadSafeMapper
|
@ThreadSafeMapper
|
||||||
@Categories(Category.datetime)
|
@Categories(Category.datetime)
|
||||||
|
@ -15,16 +15,7 @@ import java.util.function.LongFunction;
|
|||||||
* with the lower bounds set to the lower bound of the precision and millisecond
|
* with the lower bounds set to the lower bound of the precision and millisecond
|
||||||
* provided, and with no upper bound.
|
* provided, and with no upper bound.
|
||||||
* You can use any of these precisions to control the bounds
|
* You can use any of these precisions to control the bounds
|
||||||
* around the provided timestamp:
|
* around the provided timestamp: millisecond, second, minute, hour, day, month, or year.
|
||||||
* <ul>
|
|
||||||
* <LI>millisecond</LI>
|
|
||||||
* <LI>second</LI>
|
|
||||||
* <LI>minute</LI>
|
|
||||||
* <LI>hour</LI>
|
|
||||||
* <li>day</li>
|
|
||||||
* <li>month</li>
|
|
||||||
* <li>year</li>
|
|
||||||
* </ul>
|
|
||||||
*/
|
*/
|
||||||
@ThreadSafeMapper
|
@ThreadSafeMapper
|
||||||
@Categories(Category.datetime)
|
@Categories(Category.datetime)
|
||||||
|
@ -15,16 +15,7 @@ import java.util.function.LongFunction;
|
|||||||
* with the upper bound set to the upper bound of the precision and millisecond
|
* with the upper bound set to the upper bound of the precision and millisecond
|
||||||
* provided, and with no lower bound.
|
* provided, and with no lower bound.
|
||||||
* You can use any of these precisions to control the bounds
|
* You can use any of these precisions to control the bounds
|
||||||
* around the provided timestamp:
|
* around the provided timestamp: millisecond, second, minute, hour, day, month, or year.
|
||||||
* <ul>
|
|
||||||
* <LI>millisecond</LI>
|
|
||||||
* <LI>second</LI>
|
|
||||||
* <LI>minute</LI>
|
|
||||||
* <LI>hour</LI>
|
|
||||||
* <li>day</li>
|
|
||||||
* <li>month</li>
|
|
||||||
* <li>year</li>
|
|
||||||
* </ul>
|
|
||||||
*/
|
*/
|
||||||
@ThreadSafeMapper
|
@ThreadSafeMapper
|
||||||
@Categories(Category.datetime)
|
@Categories(Category.datetime)
|
||||||
|
@ -15,19 +15,8 @@ import java.util.stream.Collectors;
|
|||||||
/**
|
/**
|
||||||
* Computes the digest of the ByteBuffer on input and stores it in the output
|
* Computes the digest of the ByteBuffer on input and stores it in the output
|
||||||
* ByteBuffer. The digestTypes available are:
|
* ByteBuffer. The digestTypes available are:
|
||||||
* <UL>
|
* MD2 MD5 SHA-1 SHA-224 SHA-256 SHA-384 SHA-512 SHA3-224 SHA3-256
|
||||||
* <LI>MD2</LI>
|
* SHA3-384 SHA3-512
|
||||||
* <LI>MD5</LI>
|
|
||||||
* <LI>SHA-1</LI>
|
|
||||||
* <LI>SHA-224</LI>
|
|
||||||
* <LI>SHA-256</LI>
|
|
||||||
* <LI>SHA-384</LI>
|
|
||||||
* <LI>SHA-512</LI>
|
|
||||||
* <LI>SHA3-224</LI>
|
|
||||||
* <LI>SHA3-256</LI>
|
|
||||||
* <LI>SHA3-384</LI>
|
|
||||||
* <LI>SHA3-512</LI>
|
|
||||||
* </UL>
|
|
||||||
*/
|
*/
|
||||||
@Categories(Category.conversion)
|
@Categories(Category.conversion)
|
||||||
@ThreadSafeMapper
|
@ThreadSafeMapper
|
||||||
|
@ -37,7 +37,7 @@ public class FDocCtor {
|
|||||||
sb.append(" - *notes:* ").append(ctorJavaDoc).append("\n");
|
sb.append(" - *notes:* ").append(ctorJavaDoc).append("\n");
|
||||||
}
|
}
|
||||||
for (List<String> example : examples) {
|
for (List<String> example : examples) {
|
||||||
sb.append(" - *ex:* `").append(example.get(0)).append("`\n");
|
sb.append(" - *example:* `").append(example.get(0)).append("`\n");
|
||||||
if (example.size()>1) {
|
if (example.size()>1) {
|
||||||
sb.append(" - *").append(example.get(1)).append("*\n");
|
sb.append(" - *").append(example.get(1)).append("*\n");
|
||||||
}
|
}
|
||||||
|
@ -6,21 +6,10 @@ weight: 30
|
|||||||
## DigestToByteBuffer
|
## DigestToByteBuffer
|
||||||
|
|
||||||
Computes the digest of the ByteBuffer on input and stores it in the output ByteBuffer. The digestTypes available are:
|
Computes the digest of the ByteBuffer on input and stores it in the output ByteBuffer. The digestTypes available are:
|
||||||
|
MD2, MD5, SHA-1, SHA-224, SHA-256, SHA-384, SHA-512, SHA3-224, SHA3-256, SHA3-384, SHA3-512.
|
||||||
|
|
||||||
* MD2
|
* java.nio.ByteBuffer -> DigestToByteBuffer(java.lang.String: digestType) -> java.nio.ByteBuffer
|
||||||
* MD5
|
* long -> DigestToByteBuffer(java.lang.String: digestType) -> java.nio.ByteBuffer
|
||||||
* SHA-1
|
|
||||||
* SHA-224
|
|
||||||
* SHA-256
|
|
||||||
* SHA-384
|
|
||||||
* SHA-512
|
|
||||||
* SHA3-224
|
|
||||||
* SHA3-256
|
|
||||||
* SHA3-384
|
|
||||||
* SHA3-512
|
|
||||||
|
|
||||||
- java.nio.ByteBuffer -> DigestToByteBuffer(java.lang.String: digestType) -> java.nio.ByteBuffer
|
|
||||||
- long -> DigestToByteBuffer(java.lang.String: digestType) -> java.nio.ByteBuffer
|
|
||||||
|
|
||||||
|
|
||||||
## Flow
|
## Flow
|
||||||
|
Loading…
Reference in New Issue
Block a user