Merge branch 'main' into issue-#461-do-not-init-BinaryHandlerBitSet-on-android

Author: zdenek-jonas

.github/workflows/generate-maven-sbom.yml

@@ -0,0 +1,74 @@
+name: Generate Maven SBOM
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    # Provide custom 'Version' input, to allow running the workflow for older
+    # git refs, where the workflow file did not exist yet. This is not possible
+    # with the builtin "Use workflow from" input field.
+    inputs:
+      version:
+        description: "Version"
+        default: "main"
+        required: true
+
+env:
+  JAVA_VERSION: '17'
+  JAVA_DISTRO: 'temurin'
+  PLUGIN_VERSION: '2.9.1'
+  SBOM_TYPE: 'makeAggregateBom'
+  PROJECT_VERSION: "${{ github.event_name == 'release' && github.event.release.tag_name || github.event.inputs.version }}"
+
+permissions:
+  contents: read
+
+jobs:
+  generate-sbom:
+    runs-on: ubuntu-latest
+    outputs:
+      # Make env var available in re-usuable workflow (see actions/runner#2372)
+      project-version: ${{ env.PROJECT_VERSION }}
+    steps:
+      - name: Checkout repository at '${{ env.PROJECT_VERSION }}'
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          fetch-depth: 0
+          ref: ${{ env.PROJECT_VERSION }}
+          persist-credentials: false
+
+      - name: Setup Java SDK
+        uses: actions/setup-java@dded0888837ed1f317902acf8a20df0ad188d165 # v5.0.0
+        with:
+          java-version: ${{ env.JAVA_VERSION }}
+          distribution: ${{ env.JAVA_DISTRO }}
+
+      - name: Generate
+        run: |
+          if git show-ref --tags --quiet --verify "refs/tags/${PROJECT_VERSION}"; then
+            mvn versions:set -DnewVersion=${PROJECT_VERSION} --batch-mode
+          fi
+          # Generate SBOMs. 'skipNotDeployed' is needed
+          # to generate an SBOM outside of the deployment phase.
+
+          mvn org.cyclonedx:cyclonedx-maven-plugin:${PLUGIN_VERSION}:${SBOM_TYPE} \
+              -Dcyclonedx.skipNotDeployed=false \
+              -DoutputName=Eclipse-Serializer-Sbom \
+              -DoutputDirectory=target/sbom
+
+      - name: Upload
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        with:
+          name: sbom
+          path: target/sbom/Eclipse-Serializer-Sbom.json
+
+  # Store SBOM and metadata in a predefined format for otterdog to pick up
+  store-sbom-data:
+    needs: ['generate-sbom']
+    uses: eclipse-csi/workflows/.github/workflows/store-sbom-data.yml@main
+    with:
+      projectName: 'serializer'
+      projectVersion: ${{ needs.generate-sbom.outputs.project-version }}
+      bomArtifact: 'sbom'
+      bomFilename: 'Eclipse-Serializer-Sbom.json'
+      parentProject: '8fe715dc-b201-45e0-b6e0-5eb8da2ff4cf'

README.md

@@ -49,7 +49,7 @@ Classes evolve over time. Therefore, Eclipse Serializer provides a legacy type m
 <dependency>
   <groupId>org.eclipse.serializer</groupId>
   <artifactId>serializer</artifactId>
-  <version>3.0.0</version>
+  <version>3.0.1</version>
 </dependency>
 ```
 
@@ -83,3 +83,11 @@ If you want to contribute to this project, please read our [guidelines](CONTRIBU
 
 - [Eclipse project page](https://projects.eclipse.org/projects/technology.serializer)
 - [Dev mailing list](https://accounts.eclipse.org/mailing-list/serializer-dev)
+
+## SBOM
+
+To enhance supply chain security and offer users clear insight into project
+components, Eclipse Serializer now generates a Software Bill of Materials (SBOM) for
+every release. These are published to the Eclipse Foundation SBOM registry,
+with access instructions and usage details available in this [documentation]
+(https://eclipse-csi.github.io/security-handbook/sbom/registry.html).

afs/afs/src/main/java/org/eclipse/serializer/afs/types/AccessManager.java

@@ -14,21 +14,15 @@
  * #L%
  */
 
-import static org.eclipse.serializer.util.X.notNull;
-
-import java.util.function.Function;
-
-import org.eclipse.serializer.util.X;
-import org.eclipse.serializer.afs.exceptions.AfsExceptionConsistency;
-import org.eclipse.serializer.afs.exceptions.AfsExceptionExclusiveAttemptConflict;
-import org.eclipse.serializer.afs.exceptions.AfsExceptionExclusiveAttemptSharedUserConflict;
-import org.eclipse.serializer.afs.exceptions.AfsExceptionMutation;
-import org.eclipse.serializer.afs.exceptions.AfsExceptionMutationInUse;
-import org.eclipse.serializer.afs.exceptions.AfsExceptionSharedAttemptExclusiveUserConflict;
+import org.eclipse.serializer.afs.exceptions.*;
 import org.eclipse.serializer.chars.XChars;
 import org.eclipse.serializer.collections.HashTable;
 import org.eclipse.serializer.collections.XArrays;
-import org.eclipse.serializer.collections.interfaces.OptimizableCollection;
+import org.eclipse.serializer.util.X;
+
+import java.util.function.Function;
+
+import static org.eclipse.serializer.util.X.notNull;
 
 public interface AccessManager
 {
@@ -831,7 +825,7 @@ protected boolean internalUnregister(final AReadableFile file)
 			return true;
 		}
 
-		private static void optimizeMemoryUsage(final OptimizableCollection collection)
+		private static void optimizeMemoryUsage(final HashTable<?, ?> collection)
 		{
 			if((collection.size() & 127) != 0)
 			{

base/pom.xml

@@ -19,74 +19,11 @@
 	<description>Commons Module of the Eclipse Serializer Framework</description>
 	<url>https://projects.eclipse.org/projects/technology.serializer</url>
 
-	<properties>
-		<maven.compiler.compilerId>eclipse</maven.compiler.compilerId>
-	</properties>
-
 	<dependencies>
 		<dependency>
 			<groupId>org.slf4j</groupId>
 			<artifactId>slf4j-api</artifactId>
-			<version>1.7.36</version>
-			<scope>provided</scope>
 		</dependency>
 	</dependencies>
 
-	<build>
-		<plugins>
-			<plugin>
-				<groupId>org.apache.maven.plugins</groupId>
-				<artifactId>maven-compiler-plugin</artifactId>
-				<executions>
-					<execution>
-						<id>default-compile</id>
-						<configuration>
-							<compilerArgument>-proc:none</compilerArgument>
-						</configuration>
-					</execution>
-				</executions>
-				<dependencies>
-					<dependency>
-						<groupId>org.codehaus.plexus</groupId>
-						<artifactId>plexus-compiler-eclipse</artifactId>
-						<version>2.11.1</version>
-					</dependency>
-					<dependency>
-						<groupId>org.eclipse.jdt</groupId>
-						<artifactId>ecj</artifactId>
-						<version>${org.eclipse.jdt.ecj.version}</version>
-					</dependency>
-				</dependencies>
-			</plugin>
-		</plugins>
-	</build>
-
-	<profiles>
-		<profile>
-			<id>eclipse</id>
-			<activation>
-				<property>
-					<name>maven.compiler.compilerId</name>
-					<value>!javac</value>
-				</property>
-			</activation>
-			<build>
-				<plugins>
-					<plugin>
-						<groupId>org.apache.maven.plugins</groupId>
-						<artifactId>maven-compiler-plugin</artifactId>
-						<executions>
-							<execution>
-								<id>default-compile</id>
-								<configuration>
-									<compilerArgument>-warn:-serial,-unusedImport</compilerArgument>
-								</configuration>
-							</execution>
-						</executions>
-					</plugin>
-				</plugins>
-			</build>
-		</profile>
-	</profiles>
-
 </project>

base/src/main/java/org/eclipse/serializer/collections/AbstractArrayCollection.java

@@ -14,7 +14,6 @@
  * #L%
  */
 
-import org.eclipse.serializer.collections.interfaces.Sized;
 import org.eclipse.serializer.math.XMath;
 import org.eclipse.serializer.util.X;
 
@@ -24,7 +23,7 @@
  * 
  *
  */
-public abstract class AbstractArrayCollection<E> extends AbstractExtendedCollection<E> implements Sized
+public abstract class AbstractArrayCollection<E> extends AbstractBaseCollection<E>
 {
 	///////////////////////////////////////////////////////////////////////////
 	// constants //
@@ -40,26 +39,26 @@ public abstract class AbstractArrayCollection<E> extends AbstractExtendedCollect
 	///////////////////
 
 	@SuppressWarnings("unchecked")
-	protected static final <E> E marker()
+	protected static <E> E marker()
 	{
 		return (E)MARKER;
 	}
 
 
 	@SuppressWarnings("unchecked")
-	protected static final <E> E[] newArray(final int length)
+	protected static <E> E[] newArray(final int length)
 	{
 		return (E[])new Object[length];
 	}
 
-	protected static final <E> E[] newArray(final int length, final E[] oldData, final int oldDataLength)
+	protected static <E> E[] newArray(final int length, final E[] oldData, final int oldDataLength)
 	{
 		final E[] newArray = newArray(length);
 		System.arraycopy(oldData, 0, newArray, 0, oldDataLength);
 		return newArray;
 	}
 
-	public static final int pow2BoundMaxed(final long n)
+	public static int pow2BoundMaxed(final long n)
 	{
 		return XMath.pow2BoundMaxed(X.checkArrayRange(n));
 	}

base/src/main/java/org/eclipse/serializer/collections/AbstractExtendedCollection.java renamed to base/src/main/java/org/eclipse/serializer/collections/AbstractBaseCollection.java

@@ -14,8 +14,7 @@
  * #L%
  */
 
-import org.eclipse.serializer.collections.interfaces.ExtendedCollection;
-import org.eclipse.serializer.collections.types.XAddingCollection;
+import org.eclipse.serializer.collections.interfaces.XBaseCollection;
 import org.eclipse.serializer.collections.types.XGettingCollection;
 import org.eclipse.serializer.exceptions.ArrayCapacityException;
 import org.eclipse.serializer.exceptions.IndexBoundsException;
@@ -24,12 +23,6 @@
 /**
  * This class is an implementation-internal for optional performance optimisation.
  * <p>
- * It is the base class for every extended collection, even if the extending class does not implement
- * {@link XAddingCollection}. Subclasses of this class that do not implement {@link XAddingCollection} will throw an
- * {@link UnsupportedOperationException} in the adding methods defined in this class.<br>
- * All code using the optimisation methods in here has to ensure that it can only be legally called for implementations
- * of {@link XAddingCollection}, for example by using {@link XAddingCollection} as the concrete parameter type.
- * <p>
  * Note that this technique of using {@link UnsupportedOperationException} is explicitly not comparable to the
  * JDK's approach like in {@link java.util.Collections#unmodifiableCollection(java.util.Collection)} where a
  * general purpose type (java.util.Collection) is implemented broken to achieve a certain reduced
@@ -39,7 +32,7 @@
  *
  * @param <E> type of contained elements
  */
-public abstract class AbstractExtendedCollection<E> implements ExtendedCollection<E>
+public abstract class AbstractBaseCollection<E> implements XBaseCollection
 {
 	public static void validateIndex(final long bound, final long index) throws IndexBoundsException
 	{

base/src/main/java/org/eclipse/serializer/collections/AbstractChainCollection.java

@@ -19,13 +19,11 @@
 
 
 public abstract class AbstractChainCollection<E, K, V, EN extends AbstractChainEntry<E, K, V, EN>>
-extends AbstractExtendedCollection<E>
+extends AbstractBaseCollection<E>
 {
 	protected abstract ChainStorage<E, K, V, EN> getInternalStorageChain();
 
 	protected abstract void internalRemoveEntry(EN chainEntry);
-	
-	protected abstract long size();
 
 	protected abstract int internalRemoveNullEntries();
 

base/src/main/java/org/eclipse/serializer/collections/AbstractChainKeyValueCollection.java

@@ -19,9 +19,6 @@
 public abstract class AbstractChainKeyValueCollection<K, V, EN extends AbstractChainEntry<KeyValue<K, V>, K, V, EN>>
 extends AbstractChainCollection<KeyValue<K, V>, K, V, EN>
 {
-	@Override
-	protected abstract long size();
-
 	@Override
 	protected abstract void internalRemoveEntry(EN chainEntry);
 

base/src/main/java/org/eclipse/serializer/collections/ArrayView.java

@@ -14,33 +14,28 @@
  * #L%
  */
 
-import java.util.Comparator;
-import java.util.Iterator;
-import java.util.List;
-import java.util.ListIterator;
-import java.util.function.BiConsumer;
-import java.util.function.Consumer;
-import java.util.function.Predicate;
-
 import org.eclipse.serializer.collections.types.XGettingCollection;
 import org.eclipse.serializer.collections.types.XGettingList;
 import org.eclipse.serializer.collections.types.XImmutableList;
-import org.eclipse.serializer.collections.types.XList;
-import org.eclipse.serializer.collections.types.XSettingList;
 import org.eclipse.serializer.equality.Equalator;
 import org.eclipse.serializer.exceptions.IndexBoundsException;
 import org.eclipse.serializer.functional.IndexedAcceptor;
 import org.eclipse.serializer.typing.XTypes;
 import org.eclipse.serializer.util.X;
 import org.eclipse.serializer.util.iterables.ReadOnlyListIterator;
 
+import java.util.Comparator;
+import java.util.Iterator;
+import java.util.List;
+import java.util.ListIterator;
+import java.util.function.BiConsumer;
+import java.util.function.Consumer;
+import java.util.function.Predicate;
+
 
 /**
  * Immutable implementation of extended collection type {@link XGettingList}.
  * <p>
- * For mutable extended lists (implementors of {@link XSettingList}, {@link XList}), see {@link FixedList},
- * {@link LimitList}, {@link BulkList}.
- * <p>
  * As instances of this class are completely immutable after creation, this list is automatically thread-safe.
  * <p>
  * Also note that by being an extended collection, this implementation offers various functional and batch procedures