Skip to content

Commit 8768ef8

Browse files
LiosKLiosK
committed
build: prepare for release
1 parent 7bba2f9 commit 8768ef8

17 files changed

+40
-34
lines changed

‎CHANGELOG.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# Changelog
22

3-
## v3.0.2 - unreleased
3+
## v3.0.2 - 2023-09-18
44

55
### Maintenance
66

7+
- Improved documentation about generator's clock rollback behavior
78
- Updated gradlew
89

910
## v3.0.1 - 2023-07-19

‎build.gradle.kts

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ plugins {
55
}
66

77
group = "io.github.scru128"
8-
version = "3.0.1"
8+
version = "3.0.2"
99

1010
repositories {
1111
mavenCentral()

‎docs/allclasses-frame.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<html lang="en">
44
<head>
55
<!-- Generated by javadoc -->
6-
<title>All Classes (scru128 3.0.1 API)</title>
6+
<title>All Classes (scru128 3.0.2 API)</title>
77
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
88
<script type="text/javascript" src="script.js"></script>
99
</head>

‎docs/allclasses-noframe.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<html lang="en">
44
<head>
55
<!-- Generated by javadoc -->
6-
<title>All Classes (scru128 3.0.1 API)</title>
6+
<title>All Classes (scru128 3.0.2 API)</title>
77
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
88
<script type="text/javascript" src="script.js"></script>
99
</head>

‎docs/constant-values.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
<html lang="en">
44
<head>
55
<!-- Generated by javadoc -->
6-
<title>Constant Field Values (scru128 3.0.1 API)</title>
6+
<title>Constant Field Values (scru128 3.0.2 API)</title>
77
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
88
<script type="text/javascript" src="script.js"></script>
99
</head>
1010
<body>
1111
<script type="text/javascript"><!--
1212
try {
1313
if (location.href.indexOf('is-external=true') == -1) {
14-
parent.document.title="Constant Field Values (scru128 3.0.1 API)";
14+
parent.document.title="Constant Field Values (scru128 3.0.2 API)";
1515
}
1616
}
1717
catch(err) {

‎docs/deprecated-list.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
<html lang="en">
44
<head>
55
<!-- Generated by javadoc -->
6-
<title>Deprecated List (scru128 3.0.1 API)</title>
6+
<title>Deprecated List (scru128 3.0.2 API)</title>
77
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
88
<script type="text/javascript" src="script.js"></script>
99
</head>
1010
<body>
1111
<script type="text/javascript"><!--
1212
try {
1313
if (location.href.indexOf('is-external=true') == -1) {
14-
parent.document.title="Deprecated List (scru128 3.0.1 API)";
14+
parent.document.title="Deprecated List (scru128 3.0.2 API)";
1515
}
1616
}
1717
catch(err) {

‎docs/help-doc.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
<html lang="en">
44
<head>
55
<!-- Generated by javadoc -->
6-
<title>API Help (scru128 3.0.1 API)</title>
6+
<title>API Help (scru128 3.0.2 API)</title>
77
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
88
<script type="text/javascript" src="script.js"></script>
99
</head>
1010
<body>
1111
<script type="text/javascript"><!--
1212
try {
1313
if (location.href.indexOf('is-external=true') == -1) {
14-
parent.document.title="API Help (scru128 3.0.1 API)";
14+
parent.document.title="API Help (scru128 3.0.2 API)";
1515
}
1616
}
1717
catch(err) {

‎docs/index-all.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
<html lang="en">
44
<head>
55
<!-- Generated by javadoc -->
6-
<title>Index (scru128 3.0.1 API)</title>
6+
<title>Index (scru128 3.0.2 API)</title>
77
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
88
<script type="text/javascript" src="script.js"></script>
99
</head>
1010
<body>
1111
<script type="text/javascript"><!--
1212
try {
1313
if (location.href.indexOf('is-external=true') == -1) {
14-
parent.document.title="Index (scru128 3.0.1 API)";
14+
parent.document.title="Index (scru128 3.0.2 API)";
1515
}
1616
}
1717
catch(err) {

‎docs/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<html lang="en">
44
<head>
55
<!-- Generated by javadoc -->
6-
<title>scru128 3.0.1 API</title>
6+
<title>scru128 3.0.2 API</title>
77
<script type="text/javascript">
88
tmpTargetPage = "" + window.location.search;
99
if (tmpTargetPage != "" && tmpTargetPage != "undefined")

‎docs/io/github/scru128/Scru128.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
<html lang="en">
44
<head>
55
<!-- Generated by javadoc -->
6-
<title>Scru128 (scru128 3.0.1 API)</title>
6+
<title>Scru128 (scru128 3.0.2 API)</title>
77
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
88
<script type="text/javascript" src="../../../script.js"></script>
99
</head>
1010
<body>
1111
<script type="text/javascript"><!--
1212
try {
1313
if (location.href.indexOf('is-external=true') == -1) {
14-
parent.document.title="Scru128 (scru128 3.0.1 API)";
14+
parent.document.title="Scru128 (scru128 3.0.2 API)";
1515
}
1616
}
1717
catch(err) {

‎docs/io/github/scru128/Scru128Generator.html

+13-8
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
<html lang="en">
44
<head>
55
<!-- Generated by javadoc -->
6-
<title>Scru128Generator (scru128 3.0.1 API)</title>
6+
<title>Scru128Generator (scru128 3.0.2 API)</title>
77
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
88
<script type="text/javascript" src="../../../script.js"></script>
99
</head>
1010
<body>
1111
<script type="text/javascript"><!--
1212
try {
1313
if (location.href.indexOf('is-external=true') == -1) {
14-
parent.document.title="Scru128Generator (scru128 3.0.1 API)";
14+
parent.document.title="Scru128Generator (scru128 3.0.2 API)";
1515
}
1616
}
1717
catch(err) {
@@ -115,7 +115,7 @@ <h2 title="Class Scru128Generator" class="title">Class Scru128Generator</h2>
115115
implements java.lang.Iterable&lt;<a href="../../../io/github/scru128/Scru128Id.html" title="class in io.github.scru128">Scru128Id</a>&gt;, java.util.Iterator&lt;<a href="../../../io/github/scru128/Scru128Id.html" title="class in io.github.scru128">Scru128Id</a>&gt;</pre>
116116
<div class="block">Represents a SCRU128 ID generator that encapsulates the monotonic counters and other internal states.
117117
<p>
118-
The generator offers four different methods to generate a SCRU128 ID:
118+
The generator comes with four different methods that generate a SCRU128 ID:
119119
<table border="1">
120120
<caption>Comparison of generator functions</caption>
121121
<tr><th>Flavor</th> <th>Timestamp</th><th>Thread-</th><th>On big clock rewind</th></tr>
@@ -125,11 +125,16 @@ <h2 title="Class Scru128Generator" class="title">Class Scru128Generator</h2>
125125
<tr><td><a href="../../../io/github/scru128/Scru128Generator.html#generateOrAbortCore-long-long-"><code>generateOrAbortCore(long, long)</code></a></td><td>Argument</td> <td>Unsafe</td> <td>Returns null</td></tr>
126126
</table>
127127
<p>
128-
All of these methods return monotonically increasing IDs unless a timestamp provided is significantly (by default,
129-
more than ten seconds) smaller than the one embedded in the immediately preceding ID. If such a significant clock
130-
rollback is detected, the <code>generate</code> (OrReset) method resets the generator and returns a new ID based on the
131-
given timestamp, while the <code>OrAbort</code> variants abort and return null. The <code>Core</code> functions offer
132-
low-level thread-unsafe primitives.</div>
128+
All of the four return a monotonically increasing ID by reusing the previous timestamp even if the one provided is
129+
smaller than the immediately preceding ID's. However, when such a clock rollback is considered significant (by
130+
default, more than ten seconds):
131+
<ol>
132+
<li><code>generate</code> (OrReset) methods reset the generator and return a new ID based on the given timestamp, breaking
133+
the increasing order of IDs.</li>
134+
<li><code>OrAbort</code> variants abort and return null immediately.</li>
135+
</ol>
136+
<p>
137+
The <code>Core</code> functions offer low-level thread-unsafe primitives to customize the behavior.</div>
133138
</li>
134139
</ul>
135140
</div>

‎docs/io/github/scru128/Scru128Id.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
<html lang="en">
44
<head>
55
<!-- Generated by javadoc -->
6-
<title>Scru128Id (scru128 3.0.1 API)</title>
6+
<title>Scru128Id (scru128 3.0.2 API)</title>
77
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
88
<script type="text/javascript" src="../../../script.js"></script>
99
</head>
1010
<body>
1111
<script type="text/javascript"><!--
1212
try {
1313
if (location.href.indexOf('is-external=true') == -1) {
14-
parent.document.title="Scru128Id (scru128 3.0.1 API)";
14+
parent.document.title="Scru128Id (scru128 3.0.2 API)";
1515
}
1616
}
1717
catch(err) {

‎docs/io/github/scru128/package-frame.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<html lang="en">
44
<head>
55
<!-- Generated by javadoc -->
6-
<title>io.github.scru128 (scru128 3.0.1 API)</title>
6+
<title>io.github.scru128 (scru128 3.0.2 API)</title>
77
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
88
<script type="text/javascript" src="../../../script.js"></script>
99
</head>

‎docs/io/github/scru128/package-summary.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
<html lang="en">
44
<head>
55
<!-- Generated by javadoc -->
6-
<title>io.github.scru128 (scru128 3.0.1 API)</title>
6+
<title>io.github.scru128 (scru128 3.0.2 API)</title>
77
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
88
<script type="text/javascript" src="../../../script.js"></script>
99
</head>
1010
<body>
1111
<script type="text/javascript"><!--
1212
try {
1313
if (location.href.indexOf('is-external=true') == -1) {
14-
parent.document.title="io.github.scru128 (scru128 3.0.1 API)";
14+
parent.document.title="io.github.scru128 (scru128 3.0.2 API)";
1515
}
1616
}
1717
catch(err) {

‎docs/io/github/scru128/package-tree.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
<html lang="en">
44
<head>
55
<!-- Generated by javadoc -->
6-
<title>io.github.scru128 Class Hierarchy (scru128 3.0.1 API)</title>
6+
<title>io.github.scru128 Class Hierarchy (scru128 3.0.2 API)</title>
77
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
88
<script type="text/javascript" src="../../../script.js"></script>
99
</head>
1010
<body>
1111
<script type="text/javascript"><!--
1212
try {
1313
if (location.href.indexOf('is-external=true') == -1) {
14-
parent.document.title="io.github.scru128 Class Hierarchy (scru128 3.0.1 API)";
14+
parent.document.title="io.github.scru128 Class Hierarchy (scru128 3.0.2 API)";
1515
}
1616
}
1717
catch(err) {

‎docs/overview-tree.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
<html lang="en">
44
<head>
55
<!-- Generated by javadoc -->
6-
<title>Class Hierarchy (scru128 3.0.1 API)</title>
6+
<title>Class Hierarchy (scru128 3.0.2 API)</title>
77
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
88
<script type="text/javascript" src="script.js"></script>
99
</head>
1010
<body>
1111
<script type="text/javascript"><!--
1212
try {
1313
if (location.href.indexOf('is-external=true') == -1) {
14-
parent.document.title="Class Hierarchy (scru128 3.0.1 API)";
14+
parent.document.title="Class Hierarchy (scru128 3.0.2 API)";
1515
}
1616
}
1717
catch(err) {

‎docs/serialized-form.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
<html lang="en">
44
<head>
55
<!-- Generated by javadoc -->
6-
<title>Serialized Form (scru128 3.0.1 API)</title>
6+
<title>Serialized Form (scru128 3.0.2 API)</title>
77
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
88
<script type="text/javascript" src="script.js"></script>
99
</head>
1010
<body>
1111
<script type="text/javascript"><!--
1212
try {
1313
if (location.href.indexOf('is-external=true') == -1) {
14-
parent.document.title="Serialized Form (scru128 3.0.1 API)";
14+
parent.document.title="Serialized Form (scru128 3.0.2 API)";
1515
}
1616
}
1717
catch(err) {

0 commit comments

Comments
 (0)