Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #122: update refs to later RFC (9562) from one it obsoletes (4122) #123

Merged
merged 3 commits into from
Dec 11, 2024
Merged

Fix #122: update refs to later RFC (9562) from one it obsoletes (4122) #123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e65e93d
Fix #122: update refs to later RFC (9562) from one it obsoletes (4122)
cowtowncoder Dec 11, 2024
38f8784
update release notes
cowtowncoder Dec 11, 2024
dedd615
Improve README further
cowtowncoder Dec 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 (<[email protected]>) originally in 2002 and has been updated over the years.
Expand All @@ -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 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-4122 bis](https://datatracker.ietf.org/doc/draft-ietf-uuidrev-rfc4122bis/)) 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)
Expand Down
5 changes: 5 additions & 0 deletions release-notes/VERSION
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/fasterxml/uuid/UUIDType.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

/**
* Enumeration of different flavors of UUIDs: 5 specified by specs
* (<a href="http://tools.ietf.org/html/rfc4122">RFC-4122</a>)
* (<a href="http://tools.ietf.org/html/rfc9562">RFC-9562</a>)
* and one
* virtual entry ("UNKNOWN") to represent invalid one that consists of
* all zero bites
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/com/fasterxml/uuid/impl/UUIDUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public UUIDUtil() { }

/**
* Accessor for so-call "Nil UUID" (see
* <a href="https://www.rfc-editor.org/rfc/rfc4122#section-4.1.7">RFC 4122/4.1.7</a>;
* <a href="https://datatracker.ietf.org/doc/html/rfc9562#name-nil-uuid">RFC 9562, #5.9</a>;
* one that is all zeroes.
*
* @since 4.1
Expand All @@ -59,7 +59,7 @@ public static UUID nilUUID() {

/**
* Accessor for so-call "Max UUID" (see
* <a href="https://www.ietf.org/archive/id/draft-peabody-dispatch-new-uuid-format-04.html#name-max-uuid">UUID 6 draft</a>;
* <a href="https://datatracker.ietf.org/doc/html/rfc9562#name-max-uuid">RFC-9562, #5.10</a>);
* one that is all one bits
*
* @since 4.1
Expand Down