From e65e93d47257fb4fb695e8a15853a4630cbf5c8c Mon Sep 17 00:00:00 2001 From: Tatu Saloranta Date: Tue, 10 Dec 2024 17:51:49 -0800 Subject: [PATCH 1/3] Fix #122: update refs to later RFC (9562) from one it obsoletes (4122) --- README.md | 6 +++--- src/main/java/com/fasterxml/uuid/UUIDType.java | 2 +- src/main/java/com/fasterxml/uuid/impl/UUIDUtil.java | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index fba8cd7..2a280fb 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ JUG is a set of Java classes for working with UUIDs: generating UUIDs using any of standard methods, outputting efficiently, sorting and so on. -It generates UUIDs according to the [UUID specification (RFC-4122)](https://tools.ietf.org/html/rfc4122) +It generates UUIDs according to the [UUID specification (RFC-9562)](https://tools.ietf.org/html/rfc9562) (see [Wikipedia UUID page](http://en.wikipedia.org/wiki/UUID) for more explanation) JUG was written by Tatu Saloranta () originally in 2002 and has been updated over the years. @@ -12,13 +12,13 @@ JUG is licensed under [Apache License 2.0](http://www.apache.org/licenses/LICENS ## Supported UUID versions (1, 3, 4, 5, 6, 7) -JUG supports both "classic" versions defined in RFC 4122]: +JUG supports both "classic" versions defined in RFC 9562]: * `1`: time/location - based * `3` and `5`: name hash - based * `4`: random number - based -and newly (in 2022-2024) proposed (see [uuid6](https://uuid6.github.io/uuid6-ietf-draft/) and [RFC-4122 bis](https://datatracker.ietf.org/doc/draft-ietf-uuidrev-rfc4122bis/)) variants: +and newly (in 2022-2024) proposed (see [uuid6](https://uuid6.github.io/uuid6-ietf-draft/) and [RFC-9562](https://datatracker.ietf.org/doc/html/rfc9562) variants: * `6`: reordered variant of version `1` (with lexicographic ordering) * `7`: Unix-timestamp + random based variant (also with lexicographic ordering) diff --git a/src/main/java/com/fasterxml/uuid/UUIDType.java b/src/main/java/com/fasterxml/uuid/UUIDType.java index ee33b2f..1794b86 100644 --- a/src/main/java/com/fasterxml/uuid/UUIDType.java +++ b/src/main/java/com/fasterxml/uuid/UUIDType.java @@ -2,7 +2,7 @@ /** * Enumeration of different flavors of UUIDs: 5 specified by specs - * (RFC-4122) + * (RFC-9562) * and one * virtual entry ("UNKNOWN") to represent invalid one that consists of * all zero bites diff --git a/src/main/java/com/fasterxml/uuid/impl/UUIDUtil.java b/src/main/java/com/fasterxml/uuid/impl/UUIDUtil.java index b2d5291..e66041f 100644 --- a/src/main/java/com/fasterxml/uuid/impl/UUIDUtil.java +++ b/src/main/java/com/fasterxml/uuid/impl/UUIDUtil.java @@ -46,7 +46,7 @@ public UUIDUtil() { } /** * Accessor for so-call "Nil UUID" (see - * RFC 4122/4.1.7; + * RFC 9562, #5.9; * one that is all zeroes. * * @since 4.1 @@ -59,7 +59,7 @@ public static UUID nilUUID() { /** * Accessor for so-call "Max UUID" (see - * UUID 6 draft; + * RFC-9562, #5.10); * one that is all one bits * * @since 4.1 From 38f87844961fa51fef13d53e1b098ceae27a7a03 Mon Sep 17 00:00:00 2001 From: Tatu Saloranta Date: Tue, 10 Dec 2024 17:56:05 -0800 Subject: [PATCH 2/3] update release notes --- release-notes/VERSION | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/release-notes/VERSION b/release-notes/VERSION index 6e24d51..63e0c96 100644 --- a/release-notes/VERSION +++ b/release-notes/VERSION @@ -4,6 +4,11 @@ Project: java-uuid-generator Releases ============================================================================ +(not yet released) + +#122: RFC-4122 Obsoleted by RFC-9562 (document change) + (pointed out by @akefirad) + 5.1.0 (02-Jun-2024) #99: New factory method to create TimeBasedEpochRandomGenerator From dedd6151ba43a46e8f41dc06edd08f02e4d74864 Mon Sep 17 00:00:00 2001 From: Tatu Saloranta Date: Tue, 10 Dec 2024 17:59:28 -0800 Subject: [PATCH 3/3] Improve README further --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2a280fb..69d7355 100644 --- a/README.md +++ b/README.md @@ -12,13 +12,13 @@ JUG is licensed under [Apache License 2.0](http://www.apache.org/licenses/LICENS ## Supported UUID versions (1, 3, 4, 5, 6, 7) -JUG supports both "classic" versions defined in RFC 9562]: +JUG supports both "classic" versions defined in [RFC 4122](https://datatracker.ietf.org/doc/html/rfc4122): * `1`: time/location - based * `3` and `5`: name hash - based * `4`: random number - based -and newly (in 2022-2024) proposed (see [uuid6](https://uuid6.github.io/uuid6-ietf-draft/) and [RFC-9562](https://datatracker.ietf.org/doc/html/rfc9562) variants: +and newly (in 2022-) proposed (see [uuid6](https://uuid6.github.io/uuid6-ietf-draft/) and [RFC-9562](https://datatracker.ietf.org/doc/html/rfc9562) variants: * `6`: reordered variant of version `1` (with lexicographic ordering) * `7`: Unix-timestamp + random based variant (also with lexicographic ordering)