fix: javadoc

Author: honhimW

src/main/java/io/github/honhimw/uuid/Bytes.java

@@ -4,7 +4,7 @@
 
 /**
  * Byte array operation helper.
- * Without bounds check.
+ * Without bounds check(for higher performance).
  *
  * @author honhimW
  * @see java.nio.ByteBuffer something like that, but without checking.
@@ -26,55 +26,123 @@ public Bytes(byte[] bytes) {
         this.pos = 0;
     }
 
+    /**
+     * Append int to current position.
+     *
+     * @param value int value
+     * @return self
+     */
     public Bytes putInt(int value) {
         this.pos = putInt(this.bytes, this.pos, value);
         return this;
     }
 
+    /**
+     * Append long to current position.
+     *
+     * @param value long value
+     * @return self
+     */
     public Bytes putLong(long value) {
         this.pos = putLong(this.bytes, this.pos, value);
         return this;
     }
 
+    /**
+     * Append short to current position.
+     *
+     * @param value short value
+     * @return self
+     */
     public Bytes putShort(short value) {
         this.pos = putShort(this.bytes, this.pos, value);
         return this;
     }
 
+    /**
+     * Append byte to current position.
+     *
+     * @param value byte value
+     * @return self
+     */
     public Bytes put(byte value) {
         this.pos = put(this.bytes, this.pos, value);
         return this;
     }
 
+    /**
+     * Append byte to target position.
+     *
+     * @param value int value
+     * @return self
+     */
     public Bytes put(int i, byte value) {
         this.bytes[i] = value;
         return this;
     }
 
+    /**
+     * Append byte-array to current position.
+     *
+     * @param value byte array
+     * @return self
+     */
     public Bytes put(byte[] value) {
         this.pos = put(this.bytes, this.pos, value);
         return this;
     }
 
+    /**
+     * Append byte-array to current position.
+     *
+     * @param value  byte array
+     * @param offset value offset
+     * @param length value length after offset
+     * @return self
+     */
     public Bytes put(byte[] value, int offset, int length) {
         this.pos = put(this.bytes, this.pos, value, offset, length);
         return this;
     }
 
+    /**
+     * Get result
+     *
+     * @return result
+     */
     public byte[] unwrap() {
         return this.bytes;
     }
 
+    /**
+     * Get one byte by index
+     *
+     * @param i index
+     * @return single byte
+     */
     public byte get(int i) {
         return this.bytes[i];
     }
 
+    /**
+     * Copy byte-array from offset with length
+     *
+     * @param offset start position
+     * @param length read length
+     * @return result
+     */
     public byte[] get(int offset, int length) {
         byte[] _bytes = new byte[length];
         System.arraycopy(this.bytes, offset, _bytes, 0, length);
         return _bytes;
     }
 
+    /**
+     * Read one int value from target index.
+     *
+     * @param i index
+     * @return int value
+     */
     public int getInt(int i) {
         int v = 0;
         v |= Byte.toUnsignedInt(bytes[i]) << 24;
@@ -84,6 +152,12 @@ public int getInt(int i) {
         return v;
     }
 
+    /**
+     * Read one long value from target index.
+     *
+     * @param i index
+     * @return long value
+     */
     public long getLong(int i) {
         long v = 0;
         v |= Byte.toUnsignedLong(bytes[i]) << 56;
@@ -97,17 +171,34 @@ public long getLong(int i) {
         return v;
     }
 
+    /**
+     * Read short int value from target index.
+     *
+     * @param i index
+     * @return short value
+     */
     public short getShort(int i) {
         int v = 0;
         v |= Byte.toUnsignedInt(bytes[i]) << 8;
         v |= Byte.toUnsignedInt(bytes[i + 1]);
         return (short) v;
     }
 
+    /**
+     * Get current position
+     *
+     * @return position
+     */
     public int position() {
         return this.pos;
     }
 
+    /**
+     * Set current index.
+     *
+     * @param index target index
+     * @return self
+     */
     public Bytes position(int index) {
         this.pos = index;
         return this;
@@ -142,6 +233,14 @@ public String toString() {
         return sb.toString();
     }
 
+    /**
+     * Add int value into byte-array with index.
+     *
+     * @param dist  target
+     * @param index position
+     * @param value value
+     * @return next index
+     */
     public static int putInt(byte[] dist, int index, int value) {
         dist[index] = (byte) (value >> 24);
         dist[index + 1] = (byte) (value >> 16);
@@ -150,12 +249,28 @@ public static int putInt(byte[] dist, int index, int value) {
         return index + 4;
     }
 
+    /**
+     * Add short value into byte-array with index.
+     *
+     * @param dist  target
+     * @param index position
+     * @param value value
+     * @return next index
+     */
     public static int putShort(byte[] dist, int index, short value) {
         dist[index] = (byte) (value >> 8);
         dist[index + 1] = (byte) value;
         return index + 2;
     }
 
+    /**
+     * Add long value into byte-array with index.
+     *
+     * @param dist  target
+     * @param index position
+     * @param value value
+     * @return next index
+     */
     public static int putLong(byte[] dist, int index, long value) {
         dist[index] = (byte) (value >> 56);
         dist[index + 1] = (byte) (value >> 48);
@@ -168,11 +283,27 @@ public static int putLong(byte[] dist, int index, long value) {
         return index + 8;
     }
 
+    /**
+     * Add byte value into byte-array with index.
+     *
+     * @param dist  target
+     * @param index position
+     * @param value value
+     * @return next index
+     */
     public static int put(byte[] dist, int index, byte value) {
         dist[index] = value;
         return index + 1;
     }
 
+    /**
+     * Add byte-array into byte-array with index.
+     *
+     * @param dist  target
+     * @param index position
+     * @param value value
+     * @return next index
+     */
     public static int put(byte[] dist, int index, byte[] value) {
         for (byte b : value) {
             dist[index] = b;
@@ -181,6 +312,16 @@ public static int put(byte[] dist, int index, byte[] value) {
         return index;
     }
 
+    /**
+     * Add int value into byte-array with index.
+     *
+     * @param dist   target
+     * @param index  position
+     * @param value  source
+     * @param offset source offset
+     * @param length source length
+     * @return next index
+     */
     public static int put(byte[] dist, int index, byte[] value, int offset, int length) {
         for (int i = 0; i < length; i++) {
             dist[index] = value[i + offset];
@@ -189,6 +330,13 @@ public static int put(byte[] dist, int index, byte[] value, int offset, int leng
         return index;
     }
 
+    /**
+     * Copy byte-array from 0 into new array.
+     *
+     * @param src    source
+     * @param length read length
+     * @return new array
+     */
     public static byte[] copyOf(byte[] src, int length) {
         byte[] dst = new byte[length];
         System.arraycopy(src, 0, dst, 0, length);

src/main/java/io/github/honhimw/uuid/ClockSequence.java

@@ -11,10 +11,29 @@
 
 public interface ClockSequence {
 
+    /**
+     * Generate sequence by unix-timestamp
+     *
+     * @param seconds unix second
+     * @param nanos   unix nanosecond
+     * @return clock sequence
+     */
     long generateSequence(long seconds, int nanos);
 
+    /**
+     * Clock sequence bit-length in uuid.
+     *
+     * @return bit length
+     */
     int usableBits();
 
+    /**
+     * Get current timestamp.
+     * <p>
+     * In most cases, millisecond is enough. {@link System#currentTimeMillis()} is much more faster than {@link Instant#now()}
+     *
+     * @return unix timestamp
+     */
     default Instant now() {
         return Instant.now();
     }

src/main/java/io/github/honhimw/uuid/Context.java

@@ -38,26 +38,58 @@ public static Builder builder() {
         return new Builder();
     }
 
+    /**
+     * Build a new UUIDv1 generator with current context.
+     *
+     * @return UUIDv1 generator
+     */
     public V1 v1() {
         return new V1(this);
     }
 
+    /**
+     * Build a new UUIDv3 generator with current context.
+     *
+     * @param namespace UUIDv3 namespace
+     * @return UUIDv3 generator
+     */
     public V3 v3(UUID namespace) {
         return new V3(this, namespace);
     }
 
+    /**
+     * Build a new UUIDv4 generator with current context.
+     *
+     * @return UUIDv4 generator
+     */
     public V4 v4() {
         return new V4(this);
     }
 
+    /**
+     * Build a new UUIDv5 generator with current context.
+     *
+     * @param namespace UUIDv5 namespace
+     * @return UUIDv5 generator
+     */
     public V5 v5(UUID namespace) {
         return new V5(this, namespace);
     }
 
+    /**
+     * Build a new UUIDv6 generator with current context.
+     *
+     * @return UUIDv6 generator
+     */
     public V6 v6() {
         return new V6(this);
     }
 
+    /**
+     * Build a new UUIDv7 generator with current context.
+     *
+     * @return UUIDv7 generator
+     */
     public V7 v7() {
         return new V7(this);
     }

src/main/java/io/github/honhimw/uuid/Generator.java

@@ -11,6 +11,14 @@
 
 public interface Generator {
 
+    /**
+     * No-args UUID generation.
+     * <p>
+     * For time-based generator, using current timestamp.
+     * <p>
+     * For name-based generator, using random bytes.
+     * @return random uuid
+     */
     UUID next();
 
 }