dorkbox
/
Utilities
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Better javadocs

This commit is contained in:
nathan 2016-03-09 01:22:54 +01:00
parent 1162d0c3f9
commit 77492816e2
2 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Dorkbox-Util/src/dorkbox/util/bytes/OptimizeUtilsByteArray.java
View File

@ -212,10 +212,11 @@ class OptimizeUtilsByteArray {
}
/**
* Returns the number of bytes that would be written with {@link #writeLong(byte[], long, boolean)}.
* Returns 1-9 bytes that would be written with {@link #writeLong(byte[], long, boolean)}.
*
* @param optimizePositive
* true if you want to optimize the number of bytes needed to write the length value
* If true, small positive numbers will be more efficient (1 byte) and small negative numbers will be inefficient (9
* bytes). This ultimately means that it will use fewer bytes for positive numbers.
*/
public static
int longLength(long value, boolean optimizePositive) {
@ -229,7 +230,8 @@ class OptimizeUtilsByteArray {
* Reads a 1-9 byte long.
*
* @param optimizePositive
* true if you want to optimize the number of bytes needed to write the length value
* If true, small positive numbers will be more efficient (1 byte) and small negative numbers will be inefficient (9
* bytes). This ultimately means that it will use fewer bytes for positive numbers.
*/
public static
long readLong(byte[] buffer, boolean optimizePositive) {
@ -244,7 +246,8 @@ class OptimizeUtilsByteArray {
*
* @param position where in the buffer to start reading
* @param optimizePositive
* true if you want to optimize the number of bytes needed to write the length value
* If true, small positive numbers will be more efficient (1 byte) and small negative numbers will be inefficient (9
* bytes). This ultimately means that it will use fewer bytes for positive numbers.
*/
public static
long readLong(final byte[] buffer, final boolean optimizePositive, int position) {
@ -468,8 +471,6 @@ class OptimizeUtilsByteArray {
return position != limit;
}
private
OptimizeUtilsByteArray() {
}

10
Dorkbox-Util/src/dorkbox/util/bytes/OptimizeUtilsByteBuf.java
View File

@ -178,10 +178,11 @@ class OptimizeUtilsByteBuf {
// long
/**
* Returns the number of bytes that would be written with {@link #writeLong(ByteBuf, long, boolean)}.
* Returns the 1-9 bytes that would be written with {@link #writeLong(ByteBuf, long, boolean)}.
*
* @param optimizePositive
* true if you want to optimize the number of bytes needed to write the length value
* If true, small positive numbers will be more efficient (1 byte) and small negative numbers will be inefficient (9
* bytes). This ultimately means that it will use fewer bytes for positive numbers.
*/
public static
int longLength(long value, boolean optimizePositive) {
@ -221,7 +222,8 @@ class OptimizeUtilsByteBuf {
* Reads a 1-9 byte long.
*
* @param optimizePositive
* true if you want to optimize the number of bytes needed to write the length value
* If true, small positive numbers will be more efficient (1 byte) and small negative numbers will be inefficient (9
* bytes). This ultimately means that it will use fewer bytes for positive numbers.
*/
public static
long readLong(ByteBuf buffer, boolean optimizePositive) {
@ -272,7 +274,7 @@ class OptimizeUtilsByteBuf {
*
* @param optimizePositive
* If true, small positive numbers will be more efficient (1 byte) and small negative numbers will be inefficient (9
* bytes).
* bytes). This ultimately means that it will use fewer bytes for positive numbers.
*
* @return the number of bytes written.
*/