Remove init(modelSTore...)

Also adds documentation to the GETTING-STARTED.md file

Author: goneall

GETTING-STARTED.md

@@ -1,8 +1,6 @@
 # Getting Started
 
-## SPDX Version 3
-
-### Programmatically Creating SPDX Data
+## Initialization
 
 Before executing any of the model class methods, the model versions need to be initialized.  This is done by calling:
 
@@ -19,6 +17,28 @@ InMemSpdxStore modelStore = new InMemSpdxStore();
 IModelCopyManager copyManager = new ModelCopyManager();
 ```
 
+Many factory and helper methods in the library make use of a DefaultModelStore 
+if no model store or copy manager is specified.
+
+The `SpdxModelFactory.init()` will create defaults for this purpose.
+
+If you would like to use a different default model store and/or copy manager, you can call:
+
+```java
+DefaultModelStore.initialize(IModelStore newModelStore, String newDefaultDocumentUri,
+                            IModelCopyManager newDefaultCopyManager);
+```
+
+The `newDefaultDocumentUri` is a default document URI used for SPDX Spec version 2 model objects.
+
+IMPORTANT NOTE: The call to `DefaultModelStore.initialize` must be made prior to or immediately after the call 
+to `SpdxModelFactory.init()`.  Otherwise, any data stored in the previous default model object will be lost.
+The `SpdxModelFactory.init()` will not overwrite an already initialized default model store.
+
+## SPDX Spec Version 3
+
+### Programmatically Creating SPDX Data
+
 All SPDX elements are required to have a unique SPDX ID which is an Object URI.  In the SPDX Java libraries, this is commonly referred to as the `objectUri` to avoid confusion with the SPDX 2.X version short SPDX IDs.
 
 A good practice is to create a common prefix to use for your programmatic session.  The prefix should be unique to the session.  There are convenience methods in the library to append identifiers unique to the model store.
@@ -29,7 +49,7 @@ In these examples, we'll use:
 String prefix = "https://org.spdx.spdxdata/899b1918-f72a-4755-9215-6262b3c346df/";
 ```
 
-Since SPDX 3.0 requires creation info on every element, the easiest way to start is to use the SPDX 3 model convenience method `SpdxModelClassFactory.createCreationInfo(...)` which will create the `Agent` and `CreationInfo` classes which can be added to all of the subsequent elements.
+Since SPDX 3.0 requires creation info on every element, the easiest way to start is to use the SPDX 3 model convenience method `SpdxModelClassFactory.createCreationInfo(...)` which will create the `Agent` and `CreationInfo` classes which can be added to all the subsequent elements.
 
 For example:
 
@@ -68,3 +88,56 @@ sbom.getElements().add(
 ```
 
 The model store, creation info, copy manager, and prefix information will all be copied from the sbom allowing you to focus just on the properties you need to add.
+
+## SPDX Spec Version 2
+
+### Programmatically Creating SPDX Data
+
+SPDX Spec version 2 stores all date within an SPDX document.  SPDX documents have a single document URI which is a 
+prefix for all IDs within the document.
+
+The SPDX document MUST be unique.
+
+Below is an example:
+
+```java
+		String newDocumentUri = "http://spdx.org/spdxdocs/spdx-example2-444504E0-4F89-41D3-9A0C-0305E82CCCCC";
+```
+
+We then need to create the SPDX document:
+
+```java
+			SpdxDocument myDoc = new SpdxDocument(
+					inMemStore,						// here we'll just use a very simple in memory store which doesn't support serialization
+					newDocumentUri,					// the URI of the document - must be globally unique
+					null,							// an optional copy manager can be provided if working with more than one store
+					true);							// this time, we want to create it
+```
+
+We now need to add the required fields to make this a valid SPDX document:
+
+```java
+			myDoc.setCreationInfo(				// Set the required creationInfo
+					myDoc.createCreationInfo(	// All model objects have a set of convenience methods to create 
+												// other model objects using the same model store and document URI
+							Arrays.asList(new String[] {"Tool: Sample App"}), // creators
+							new SimpleDateFormat(SpdxConstants.SPDX_DATE_FORMAT).format(new Date())));
+												// creation date - note that SpdxConstants has several useful constant values
+			myDoc.setSpecVersion(Version.CURRENT_SPDX_VERSION); // the Version class has constants defined for all supported SPDX spec versions
+			myDoc.setName("My Document");
+			// The LicenseInfoFactory contains some convenient static methods to manage licenses including
+			// a license parser.  Note that we have to pass in the model store and document URI so that the
+			// license is created in the same store.
+			myDoc.setDataLicense(LicenseInfoFactory.parseSPDXLicenseString("CC0-1.0", inMemStore, newDocumentUri, null));
+			// We need something for the document to describe, we'll create an SPDX file
+			AnyLicenseInfo apacheLicense = LicenseInfoFactory.parseSPDXLicenseString("Apache-2.0", inMemStore, newDocumentUri, null);
+			SpdxFile file = myDoc.createSpdxFile(
+					SpdxConstants.SPDX_ELEMENT_REF_PRENUM + "44",
+					"./myfile/name", 
+					apacheLicense, 
+					Arrays.asList(new AnyLicenseInfo[] {apacheLicense}),
+					"Copyright me, 2023",
+					myDoc.createChecksum(ChecksumAlgorithm.SHA1, "2fd4e1c67a2d28fced849ee1bb76e7391b93eb12"))
+					.build();  // The more complex model objects follows a builder pattern
+			myDoc.getDocumentDescribes().add(file);
+```

src/main/java/org/spdx/library/SpdxModelFactory.java

@@ -125,38 +125,6 @@ public static void init() {
 		}
 	}
 
-	/**
-	 * This static method is a convenience to load this class and initialize the supported model versions and
-	 * initialize the DefaultModelStore with the parameter values
-	 * <p>
-	 * It should be called before using any other functionality from the library
-	 * @param modelStore Model store to use as a default
-	 * @param defaultDocumentUri Document URI to use as a default
-	 * @param defaultCopyManager Copy manager to use as a default
-	 */
-	public static void init(IModelStore modelStore, String defaultDocumentUri,
-							IModelCopyManager defaultCopyManager) {
-		Objects.requireNonNull(modelStore, "Model store can not be null");
-		Objects.requireNonNull(defaultDocumentUri, "Document URI can not be null");
-		Objects.requireNonNull(defaultCopyManager, "Copy manager can not be null");
-		synchronized (INIT_LOCK) {
-			if (!DefaultModelStore.isInitialized()) {
-				DefaultModelStore.initialize(modelStore, defaultDocumentUri, defaultCopyManager);
-			} else {
-				try {
-					if (!(Objects.equals(modelStore, DefaultModelStore.getDefaultModelStore()) &&
-							Objects.equals(defaultDocumentUri, DefaultModelStore.getDefaultDocumentUri()) &&
-							Objects.equals(defaultCopyManager, DefaultModelStore.getDefaultCopyManager()))) {
-						logger.warn("Ignoring second call to initialize the model store");
-					}
-				} catch (DefaultStoreNotInitialized e) {
-					logger.error("Unexpected store not initialized during init", e);
-				}
-			}
-		}
-	}
-
-	
 	/**
 	 * If the object exists in the model store, it will be "inflated" back to the Java object.
 	 * If the object does not exist AND the create parameter is true, a new object will be created and
@@ -252,7 +220,7 @@ public static Object getExternalElement(IModelStore store, String uri,
 	 * @param typeFilter type to filter on
 	 * @param objectUriPrefixFilter only return objects with URI's starting with this string
 	 * @param idPrefix optional prefix used for any new object URI's created in support of this model object
-	 * @return stream of objects stored in the model store - an object being any non primitive type
+	 * @return stream of objects stored in the model store - an object being any non-primitive type
 	 * @throws InvalidSPDXAnalysisException on SPDX parsing errors
 	 */
 	public static Stream<?> getSpdxObjects(IModelStore store, @Nullable IModelCopyManager copyManager,