Add release notes wrt #52

Author: cowtowncoder

README.md

@@ -73,10 +73,11 @@ UUID uuid = gen.generate();
 UUID anotherUuid = gen.generate();
 ```
 
-If your machine has a standard IP networking setup, the `Generators.egressTimeBasedGenerator` 
+If your machine has a standard IP networking setup, the `Generators.egressTimeBasedGenerator` (added in JUG 4.1) 
 factory method will try to determine which network interface corresponds to the default route for 
-all outgoing network traffic, and use that for creating a time based generator.  This is likely a 
-good choice for common usage scenarios if you want a version 1 UUID generator:
+all outgoing network traffic, and use that for creating a time based generator.
+This is likely a  good choice for common usage scenarios if you want a version 1 UUID generator:
+
 ```java
 TimeBasedGenerator gen = Generators.egressTimeBasedGenerator();
 UUID uuid = gen.generate();

release-notes/CREDITS

@@ -118,3 +118,7 @@ Pascal Schumacher (PascalSchumacher@github)
 Hal Hildebrand (Hellblazer@github)
   * Contributed #41: Add support for Proposed type v6 (reordered timestamp)
   [4.1.0]
+
+Paul Galbraith (pgalbraith@github)
+  * Contributed #52: Add `Generators.egressTimeBasedGenerator()` method that constructs
+    `TimedBasedGenerator` with a sensible choice of interface

release-notes/VERSION

@@ -8,6 +8,9 @@ Releases
 
 #41: Add support for Proposed type v6 (reordered timestamp)
  (contributed by Hal H)
+#52: Add `Generators.egressTimeBasedGenerator()` method that constructs `TimedBasedGenerator`
+  with a sensible choice of interface
+ (contributed by Paul G)
 - Fix a minor issue with argument validation for `Jug` tool class
 - Update junit dependency (via oss-parent:41)
 - Update slf4j-api to 1.7.36

src/main/java/com/fasterxml/uuid/EthernetAddress.java

@@ -289,6 +289,8 @@ public static EthernetAddress fromInterface()
 
     /**
      * A factory method to return the ethernet address of a specified network interface.
+     *
+     * @since 4.1
      */
     public static EthernetAddress fromInterface(NetworkInterface nint) 
     {
@@ -315,6 +317,8 @@ public static EthernetAddress fromInterface(NetworkInterface nint)
      * to be the default egress interface, and the corresponding address of
      * that interface will be returned.  If all attempts are unsuccessful,
      * null will be returned.
+     *
+     * @since 4.1
      */
     public static EthernetAddress fromEgressInterface() 
     {
@@ -336,6 +340,8 @@ public static EthernetAddress fromEgressInterface()
     /**
      * A factory method to return the address of the interface used to route
      * traffic to the specified IP address.
+     *
+     * @since 4.1
      */
     public static EthernetAddress fromEgressInterface(InetSocketAddress externalSocketAddress) 
     {

src/main/java/com/fasterxml/uuid/Generators.java

@@ -130,6 +130,8 @@ public static NameBasedGenerator nameBasedGenerator(UUID namespace, MessageDiges
      * identify the egress interface once: if you have a complex network setup where your
      * outbound routes/interfaces may change dynamically, and you want your UUIDs to
      * accurately reflect which interface is being actively used, this method is not for you.
+     *
+     * @since 4.1
      */
     public static TimeBasedGenerator egressTimeBasedGenerator()
     {

src/test/java/com/fasterxml/uuid/UUIDGeneratorTest.java

@@ -40,7 +40,10 @@
 public class UUIDGeneratorTest extends TestCase
 {
     // size of the arrays to create for tests using arrays of values
-    private static final int SIZE_OF_TEST_ARRAY = 10000;
+    // 19-Jun-2022, tatu: Reduce from 10000 since that seems to sometimes
+    //    trigger timing overflow wrt sanity checks (sanity checks being
+    //    simplistic; not exposing an actual issue)
+    private static final int SIZE_OF_TEST_ARRAY = 9000;
 
     public UUIDGeneratorTest(java.lang.String testName)
     {