Add javadocs for regex patterns

Author: jormundur00

tests/tck-build-logic/src/main/groovy/org/graalvm/internal/tck/updaters/FetchExistingLibrariesWithNewerVersionsTask.groovy

@@ -25,6 +25,24 @@ abstract class FetchExistingLibrariesWithNewerVersionsTask extends DefaultTask {
     abstract ListProperty<String> getAllLibraryCoordinates()
 
     private static final List<String> INFRASTRUCTURE_TESTS = List.of("samples", "org.example")
+
+    /**
+     * Identifies pre-release library versions by pattern matching against common pre-release suffixes.
+     * <p>
+     * A version is considered pre-release if its suffix (following the last '.' or '-') matches
+     * one of these case-insensitive patterns:
+     * <ul>
+     *   <li>{@code alpha} followed by optional numbers (e.g., "alpha", "Alpha1", "alpha123")</li>
+     *   <li>{@code beta} followed by optional numbers (e.g., "beta", "Beta2", "BETA45")</li>
+     *   <li>{@code rc} followed by optional numbers (e.g., "rc", "RC1", "rc99")</li>
+     *   <li>{@code cr} followed by optional numbers (e.g., "cr", "CR3", "cr10")</li>
+     *   <li>{@code m} followed by REQUIRED numbers (e.g., "M1", "m23")</li>
+     *   <li>{@code ea} followed by optional numbers (e.g., "ea", "ea2", "ea15")</li>
+     *   <li>{@code b} followed by REQUIRED numbers (e.g., "b0244", "b5")</li>
+     *   <li>{@code preview} followed by optional numbers (e.g., "preview", "preview1", "preview42")</li>
+     *   <li>Numeric suffixes separated by '-' (e.g., "-1", "-123")</li>
+     * </ul>
+     */
     private static final Pattern PRE_RELEASE_PATTERN = ~/(?i)^(\d+(?:\.\d+)*)(?:[-.](alpha\d*|beta\d*|rc\d*|cr\d*|m\d+|ea\d*|b\d+|\d+|preview)(?:[-.].*)?)?$/
     private static final String FINAL_PATTERN = /(?i)\.Final$/
 

tests/tck-build-logic/src/main/java/org/graalvm/internal/tck/TestedVersionUpdaterTask.java

@@ -30,6 +30,23 @@
 import java.util.regex.Pattern;
 
 public abstract class TestedVersionUpdaterTask extends DefaultTask {
+    /**
+     * Identifies pre-release library versions by pattern matching against common pre-release suffixes.
+     * <p>
+     * A version is considered pre-release if its suffix (following the last '.' or '-') matches
+     * one of these case-insensitive patterns:
+     * <ul>
+     *   <li>{@code alpha} followed by optional numbers (e.g., "alpha", "Alpha1", "alpha123")</li>
+     *   <li>{@code beta} followed by optional numbers (e.g., "beta", "Beta2", "BETA45")</li>
+     *   <li>{@code rc} followed by optional numbers (e.g., "rc", "RC1", "rc99")</li>
+     *   <li>{@code cr} followed by optional numbers (e.g., "cr", "CR3", "cr10")</li>
+     *   <li>{@code m} followed by REQUIRED numbers (e.g., "M1", "m23")</li>
+     *   <li>{@code ea} followed by optional numbers (e.g., "ea", "ea2", "ea15")</li>
+     *   <li>{@code b} followed by REQUIRED numbers (e.g., "b0244", "b5")</li>
+     *   <li>{@code preview} followed by optional numbers (e.g., "preview", "preview1", "preview42")</li>
+     *   <li>Numeric suffixes separated by '-' (e.g., "-1", "-123")</li>
+     * </ul>
+     */
     private static final Pattern PRE_RELEASE_PATTERN = Pattern.compile(
             "(?i)^(\\d+(?:\\.\\d+)*)(?:[-.](alpha\\d*|beta\\d*|rc\\d*|cr\\d*|m\\d+|ea\\d*|b\\d+|\\d+|preview)(?:[-.].*)?)?$"
     );
@@ -94,13 +111,13 @@ void run() throws IllegalStateException, IOException {
      * <p>
      * Rules applied by this method:
      * <ul>
-     *     <li>If the newly added version is a full release (no pre-release label, or ending with ".Final"),
-     *         all existing pre-releases of the same base version are removed from {@code testedVersions}.</li>
-     *     <li>If the newly added version is itself a pre-release, no versions are removed.</li>
-     *     <li>If the entry's {@code metadataVersion} is a pre-release of the same base version,
-     *         it is updated to the new full release. The corresponding metadata and test directories are renamed accordingly.
-     *         The {@code gradle.properties} file in the tests directory is updated to refer to the new version.</li>
-     *     <li>Version parsing follows {@link #PRE_RELEASE_PATTERN} and treats ".Final" as a base version.</li>
+     *   <li>If the newly added version is a full release (no pre-release label, or ending with ".Final"),
+     *       all existing pre-releases of the same base version are removed from {@code testedVersions}.</li>
+     *   <li>If the newly added version is itself a pre-release, no versions are removed.</li>
+     *   <li>If the entry's {@code metadataVersion} is a pre-release of the same base version,
+     *       it is updated to the new full release. The corresponding metadata and test directories are renamed accordingly.
+     *       The {@code gradle.properties} file in the tests directory is updated to refer to the new version.</li>
+     *   <li>Version parsing follows {@link #PRE_RELEASE_PATTERN} and treats ".Final" as a base version.</li>
      * </ul>
      */
     private MetadataVersionsIndexEntry handlePreReleases(MetadataVersionsIndexEntry entry, String newVersion, Path baseDir) throws IOException {
@@ -158,13 +175,13 @@ private MetadataVersionsIndexEntry handlePreReleases(MetadataVersionsIndexEntry
      * <p>
      * This method performs two operations:
      * <ol>
-     *     <li>Renames the test directory from {@code oldVersion} to {@code newVersion} under {@code tests/src/<group>/<artifact>/}.</li>
-     *     <li>Updates the {@code gradle.properties} file inside the renamed directory:
-     *         <ul>
-     *             <li>{@code library.version} is set to the new version,</li>
-     *             <li>{@code metadata.dir} is updated to point to the metadata directory for the new version.</li>
-     *         </ul>
-     *     </li>
+     *   <li>Renames the test directory from {@code oldVersion} to {@code newVersion} under {@code tests/src/<group>/<artifact>/}.</li>
+     *   <li>Updates the {@code gradle.properties} file inside the renamed directory:
+     *     <ul>
+     *       <li>{@code library.version} is set to the new version,</li>
+     *       <li>{@code metadata.dir} is updated to point to the metadata directory for the new version.</li>
+     *     </ul>
+     *   </li>
      * </ol>
      */
     private void updateTests(Path metadataBaseDir, MetadataVersionsIndexEntry entry, String oldVersion, String newVersion) throws IOException {