andrew
/
ulid-creator
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[maven-release-plugin] prepare for next development iteration

This commit is contained in:
Fabio Lima 2021-01-30 09:29:46 -03:00
parent 9a3ca63ad6
commit 3f10989f74
3 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -45,7 +45,7 @@ Implementation
### ULID ### ULID
The ULID is a 128 bit long identifier. The first 48 bits represent the count of milliseconds since Unix Epoch, 1 January 1970. The remaining 60 bits are generated by a secure random number generator. The ULID is a 128 bit long identifier. The first 48 bits represent the count of milliseconds since Unix Epoch, 1970-01-01. The remaining 80 bits are generated by a secure random number generator.
```java ```java
// Generate a ULID // Generate a ULID
@ -84,7 +84,7 @@ Sequence of ULIDs:
### Monotonic ULID ### Monotonic ULID
The Monotonic ULID is a 128 bit long identifier. The first 48 bits represent the count of milliseconds since Unix Epoch, 1 January 1970. The remaining 60 bits are generated by a secure random number generator. The Monotonic ULID is a 128 bit long identifier. The first 48 bits represent the count of milliseconds since Unix Epoch, 1970-01-01. The remaining 80 bits are generated by a secure random number generator.
The random component is incremented by 1 whenever the current millisecond is equal to the previous one. But when the current millisecond is different, the random component changes to another random value. The random component is incremented by 1 whenever the current millisecond is equal to the previous one. But when the current millisecond is different, the random component changes to another random value.
@ -180,7 +180,7 @@ Get the random component of a ULID:
byte[] random = ulid.getRandom(); // 10 bytes (80 bits) byte[] random = ulid.getRandom(); // 10 bytes (80 bits)
``` ```
Use a `UlidFctory` instance with `java.util.Random` to generate ULIDs: Use a `UlidFactory` instance with `java.util.Random` to generate ULIDs:
```java ```java
Random random = new Random(); Random random = new Random();
@ -189,7 +189,7 @@ UlidFactory factory = UlidCreator.getDefaultFactory().withRandomGenerator(random
Ulid ulid = facory.create(); Ulid ulid = facory.create();
``` ```
Use a `UlidFctory` instance with any random generator you like(*) to generate ULIDs: Use a `UlidFactory` instance with any random generator you like(*) to generate ULIDs:
```java ```java
import com.github.niceguy.random.AwesomeRandom; // a hypothetical RNG import com.github.niceguy.random.AwesomeRandom; // a hypothetical RNG

4
pom.xml
View File

@ -3,7 +3,7 @@
<groupId>com.github.f4b6a3</groupId> <groupId>com.github.f4b6a3</groupId>
<artifactId>ulid-creator</artifactId> <artifactId>ulid-creator</artifactId>
<version>3.0.1</version> <version>3.0.2-SNAPSHOT</version>
<packaging>jar</packaging> <packaging>jar</packaging>
<name>ulid-creator</name> <name>ulid-creator</name>
@ -44,7 +44,7 @@
<url>https://github.com/f4b6a3/ulid-creator</url> <url>https://github.com/f4b6a3/ulid-creator</url>
<connection>scm:git:ssh://git@github.com/f4b6a3/ulid-creator.git</connection> <connection>scm:git:ssh://git@github.com/f4b6a3/ulid-creator.git</connection>
<developerConnection>scm:git:ssh://git@github.com/f4b6a3/ulid-creator.git</developerConnection> <developerConnection>scm:git:ssh://git@github.com/f4b6a3/ulid-creator.git</developerConnection>
<tag>ulid-creator-3.0.1</tag> <tag>HEAD</tag>
</scm> </scm>
<distributionManagement> <distributionManagement>

2
src/main/java/com/github/f4b6a3/ulid/Ulid.java
View File

@ -616,6 +616,8 @@ public final class Ulid implements Serializable, Comparable<Ulid> {
* A valid ULID string is a sequence of 26 characters from Crockford's base 32 * A valid ULID string is a sequence of 26 characters from Crockford's base 32
* alphabet. * alphabet.
* *
* The first character of the input string must be between 0 and 7.
*
* @param chars a char array * @param chars a char array
* @return boolean true if valid * @return boolean true if valid
*/ */