This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-compress.git
commit 480f2a53fd5d6248b8cb6944868fcb3b34059a51
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Tue Nov 26 10:30:08 2024 -0500
Javadoc
---
.../archivers/zip/ZipEightByteInteger.java | 56 +++++++++++-----------
1 file changed, 28 insertions(+), 28 deletions(-)
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipEightByteInteger.java
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipEightByteInteger.java
index b02bdb6f8..0e205e49b 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipEightByteInteger.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipEightByteInteger.java
@@ -44,8 +44,8 @@ public final class ZipEightByteInteger implements
Serializable {
/**
* Gets value as eight bytes in big-endian byte order.
*
- * @param value the value to convert
- * @return value as eight bytes in big-endian byte order
+ * @param value the value to convert.
+ * @return value as eight bytes in big-endian byte order.
*/
public static byte[] getBytes(final BigInteger value) {
return getBytes(value.longValue());
@@ -54,50 +54,50 @@ public final class ZipEightByteInteger implements
Serializable {
/**
* Gets value as eight bytes in big-endian byte order.
*
- * @param value the value to convert
- * @return value as eight bytes in big-endian byte order
+ * @param value the value to convert.
+ * @return value as eight bytes in big-endian byte order.
*/
public static byte[] getBytes(final long value) {
return
ByteBuffer.allocate(BYTES).order(ByteOrder.LITTLE_ENDIAN).putLong(value).array();
}
/**
- * Helper method to get the value as a Java long from an eight-byte array
+ * Gets the value as a Java long from an eight-byte array.
*
- * @param bytes the array of bytes
- * @return the corresponding Java long value
+ * @param bytes the array of bytes.
+ * @return the corresponding Java long value.
*/
public static long getLongValue(final byte[] bytes) {
return getLongValue(bytes, 0);
}
/**
- * Helper method to get the value as a Java long from eight bytes starting
at given array offset
+ * Gets the value as a Java long from eight bytes starting at given array
offset.
*
- * @param bytes the array of bytes
- * @param offset the offset to start
- * @return the corresponding Java long value
+ * @param bytes the array of bytes.
+ * @param offset the offset to start.
+ * @return the corresponding Java long value.
*/
public static long getLongValue(final byte[] bytes, final int offset) {
return
ByteBuffer.wrap(bytes).order(ByteOrder.LITTLE_ENDIAN).getLong(offset);
}
/**
- * Helper method to get the value as a Java long from an eight-byte array
+ * Gets the value as a Java long from an eight-byte array.
*
- * @param bytes the array of bytes
- * @return the corresponding Java BigInteger value
+ * @param bytes the array of bytes.
+ * @return the corresponding Java BigInteger value.
*/
public static BigInteger getValue(final byte[] bytes) {
return getValue(bytes, 0);
}
/**
- * Helper method to get the value as a Java BigInteger from eight bytes
starting at given array offset
+ * Gets the value as a Java BigInteger from eight bytes starting at given
array offset.
*
- * @param bytes the array of bytes
- * @param offset the offset to start
- * @return the corresponding Java BigInteger value
+ * @param bytes the array of bytes.
+ * @param offset the offset to start.
+ * @return the corresponding Java BigInteger value.
*/
public static BigInteger getValue(final byte[] bytes, final int offset) {
return toUnsignedBigInteger(getLongValue(bytes, offset));
@@ -126,7 +126,7 @@ public final class ZipEightByteInteger implements
Serializable {
/**
* Constructs a new instance from bytes.
*
- * @param bytes the bytes to store as a ZipEightByteInteger
+ * @param bytes the bytes to store as a ZipEightByteInteger.
*/
public ZipEightByteInteger(final byte[] bytes) {
this(bytes, 0);
@@ -135,8 +135,8 @@ public final class ZipEightByteInteger implements
Serializable {
/**
* Constructs a new instance from the eight bytes starting at offset.
*
- * @param bytes the bytes to store as a ZipEightByteInteger
- * @param offset the offset to start
+ * @param bytes the bytes to store as a ZipEightByteInteger.
+ * @param offset the offset to start.
*/
public ZipEightByteInteger(final byte[] bytes, final int offset) {
this.value = getLongValue(bytes, offset);
@@ -145,7 +145,7 @@ public final class ZipEightByteInteger implements
Serializable {
/**
* Constructs a new instance from a number.
*
- * @param value the long to store as a ZipEightByteInteger
+ * @param value the long to store as a ZipEightByteInteger.
*/
public ZipEightByteInteger(final long value) {
this.value = value;
@@ -154,8 +154,8 @@ public final class ZipEightByteInteger implements
Serializable {
/**
* Override to make two instances with same value equal.
*
- * @param o an object to compare
- * @return true if the objects are equal
+ * @param o an object to compare.
+ * @return true if the objects are equal.
*/
@Override
public boolean equals(final Object o) {
@@ -168,7 +168,7 @@ public final class ZipEightByteInteger implements
Serializable {
/**
* Gets value as eight bytes in big-endian byte order.
*
- * @return value as eight bytes in big-endian order
+ * @return value as eight bytes in big-endian order.
*/
public byte[] getBytes() {
return getBytes(value);
@@ -177,7 +177,7 @@ public final class ZipEightByteInteger implements
Serializable {
/**
* Gets value as Java long.
*
- * @return value as a long
+ * @return value as a long.
*/
public long getLongValue() {
return value;
@@ -186,7 +186,7 @@ public final class ZipEightByteInteger implements
Serializable {
/**
* Gets value as Java BigInteger.
*
- * @return value as a BigInteger
+ * @return value as a BigInteger.
*/
public BigInteger getValue() {
return toUnsignedBigInteger(value);
@@ -195,7 +195,7 @@ public final class ZipEightByteInteger implements
Serializable {
/**
* Override to make two instances with same value equal.
*
- * @return the hash code of the value stored in the ZipEightByteInteger
+ * @return the hash code of the value stored in the ZipEightByteInteger.
*/
@Override
public int hashCode() {
