Update SPDX file info header

README.md

@@ -1,13 +1,17 @@
 # spdx-model-to-java
-Generates Java source files from the SPDX spec version 3+ suitable for inclusion in the SPDX Java Library
+
+Generates Java source files from the [SPDX spec version 3+][spdx-spec]
+suitable for inclusion in the SPDX Java Library
+
+[spdx-spec]: https://spdx.dev/use/specifications/
 
 ## Usage CLI
 
 To run the utility as a command line interface, execute the main method `ShaclToJavaCli` with 2 parameters:
+
 - model file in turtle format
 - output directory
 
-
 ## Usage Library
 
 To use the code as a library, the main entry point is the `ShaclToJava` class which takes a single parameter of the SPDX Ontology model.
@@ -18,4 +22,5 @@ The `generate(dir)` method will generate the Java files in the dir directory.
 
 This is a utility specifically built and tested for use in the SPDX Java Library.  
 It is relatively stable for that purpose.
-There are still a few items marked as TODO in the code and some of the generated code will produce warnings in Java linter (e.g. unused import statements).
+
+There are still a few items marked as TODO in the code and some of the generated code will produce warnings in Java linter (e.g. unused import statements).

resources/javaTemplates/BaseModelObjectTemplate.txt

@@ -1,6 +1,7 @@
 /**
+ * SPDX-FileCopyrightText: Copyright (c) {{{year}}} Source Auditor Inc.
+ * SPDX-FileType: SOURCE
  * SPDX-License-Identifier: Apache-2.0
- * Copyright (c) 2024 Source Auditor Inc.
  */
 package org.spdx.library.model.{{versionSuffix}};
 
@@ -29,8 +30,9 @@ import org.spdx.storage.PropertyDescriptor;
 
 
 /**
- * @author Gary O'Neall
+ * Model object for SPDX 3
  *
+ * @author Gary O'Neall
  */
 public abstract class ModelObjectV3 extends CoreModelObject {
 
@@ -56,7 +58,7 @@ public abstract class ModelObjectV3 extends CoreModelObject {
 	 * @param objectUri
 	 * @param copyManager
 	 * @param create
-	 * @param idPrefix - prefix to be used when generating new SPDX IDs
+	 * @param idPrefix prefix to be used when generating new SPDX IDs
 	 * @throws InvalidSPDXAnalysisException
 	 */
 	public ModelObjectV3(IModelStore modelStore, String objectUri,
@@ -74,7 +76,6 @@ public abstract class ModelObjectV3 extends CoreModelObject {
 		super(builder, SpdxConstantsV3.MODEL_SPEC_VERSION);
 	}
 
-
 	/**
 	 * @param specVersion Version of the SPDX spec to verify against
 	 * @param verifiedElementUris list of all element object URIs which have already been verified - prevents infinite recursion
@@ -179,8 +180,7 @@ public abstract class ModelObjectV3 extends CoreModelObject {
 			throw new SpdxInvalidTypeException("Invalid type for ExtendableLicense property: "+result.get().getClass().toString());
 		}
 	}
-
-
+
 	/**
 	 * Converts property values to an ExtendableLicense if possible
 	 * @param propertyDescriptor descriptor for the property
@@ -207,7 +207,7 @@ public abstract class ModelObjectV3 extends CoreModelObject {
 			throw new SpdxInvalidTypeException("Invalid type for LicenseAddition property: "+result.get().getClass().toString());
 		}
 	}
-	
+
 	/**
 	 * Converts property values to an SpdxElement if possible - if individual value, convert to the appropriate SpdxElement
 	 * @param propertyDescriptor Descriptor for the property
@@ -234,20 +234,20 @@ public abstract class ModelObjectV3 extends CoreModelObject {
 			throw new SpdxInvalidTypeException("Invalid type for SpdxElement property: "+result.get().getClass().toString());
 		}
 	}
-	
+
 	/**
 	 * @param propertyDescriptor property descriptor for the object in question
 	 * @return true if the object is "to" part of a relationship
 	 */
 	public boolean isRelatedElement(PropertyDescriptor propertyDescriptor) {
 		return SpdxConstantsV3.PROP_TO.equals(propertyDescriptor);
 	}
-	
+
 	{{#createBuilder}}
 	{{{.}}}
-	
+
 	{{/createBuilder}}
-	
+
 	public static class ModelObjectV3Builder extends CoreModelObjectBuilder {
 
 		/**

resources/javaTemplates/CreateClassTemplate.txt

@@ -7,4 +7,4 @@
 	public {{{className}}}.{{{className}}}Builder create{{{className}}}(String objectUri) throws InvalidSPDXAnalysisException {
 		Objects.requireNonNull(objectUri, "objectUri can not be null");
 		return new {{{className}}}.{{{className}}}Builder(this, objectUri);
-	}
+	}

resources/javaTemplates/ElementToStringTemplate.txt

@@ -1,17 +1,17 @@
 try {
-			StringBuilder sb = new StringBuilder();
-			Optional<String> name = getName();
-			if (name.isPresent()) {
-				sb.append(name.get());
-			} else {
-				sb.append("[Name Missing]");
-			}
-			sb.append(":");
-			sb.append(getType());
-			sb.append('(');
-			sb.append(getObjectUri());
-			sb.append(')');
-			return sb.toString();
-		} catch (InvalidSPDXAnalysisException e) {
-			return "Error: "+e.getMessage();
-		}
+	StringBuilder sb = new StringBuilder();
+	Optional<String> name = getName();
+	if (name.isPresent()) {
+		sb.append(name.get());
+	} else {
+		sb.append("[Name Missing]");
+	}
+	sb.append(":");
+	sb.append(getType());
+	sb.append('(');
+	sb.append(getObjectUri());
+	sb.append(')');
+	return sb.toString();
+} catch (InvalidSPDXAnalysisException e) {
+	return "Error: "+e.getMessage();
+}

resources/javaTemplates/EnumTemplate.txt

@@ -1,21 +1,8 @@
 /**
- * Copyright (c) {{{year}}} Source Auditor Inc.
- *
+ * SPDX-FileCopyrightText: Copyright (c) {{{year}}} Source Auditor Inc.
+ * SPDX-FileType: SOURCE
  * SPDX-License-Identifier: Apache-2.0
- * 
- *   Licensed under the Apache License, Version 2.0 (the "License");
- *   you may not use this file except in compliance with the License.
- *   You may obtain a copy of the License at
- *
- *       http://www.apache.org/licenses/LICENSE-2.0
- *
- *   Unless required by applicable law or agreed to in writing, software
- *   distributed under the License is distributed on an "AS IS" BASIS,
- *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *   See the License for the specific language governing permissions and
- *   limitations under the License.
  */
-
 package {{{pkgName}}};
 
 import org.spdx.core.IndividualUriValue;

resources/javaTemplates/ExternalJavaClassTemplate.txt

@@ -1,21 +1,8 @@
 /**
- * Copyright (c) {{{year}}} Source Auditor Inc.
- *
+ * SPDX-FileCopyrightText: Copyright (c) {{{year}}} Source Auditor Inc.
+ * SPDX-FileType: SOURCE
  * SPDX-License-Identifier: Apache-2.0
- * 
- *   Licensed under the Apache License, Version 2.0 (the "License");
- *   you may not use this file except in compliance with the License.
- *   You may obtain a copy of the License at
- *
- *       http://www.apache.org/licenses/LICENSE-2.0
- *
- *   Unless required by applicable law or agreed to in writing, software
- *   distributed under the License is distributed on an "AS IS" BASIS,
- *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *   See the License for the specific language governing permissions and
- *   limitations under the License.
  */
-
 package {{{pkgName}}};
 
 import org.spdx.storage.NullModelStore;
@@ -28,7 +15,7 @@ import org.spdx.core.IndividualUriValue;
  * This is an external representation of {{{className}}} - nothing can be set and properties returned
  * are not valid
  *
-**/
+ */
 public class External{{{className}}} extends {{{className}}}  implements IndividualUriValue {
 
 	{{#objectPropertyValueCollection}}

resources/javaTemplates/IndividualClassTemplate.txt

@@ -1,21 +1,8 @@
 /**
- * Copyright (c) {{{year}}} Source Auditor Inc.
- *
+ * SPDX-FileCopyrightText: Copyright (c) {{{year}}} Source Auditor Inc.
+ * SPDX-FileType: SOURCE
  * SPDX-License-Identifier: Apache-2.0
- * 
- *   Licensed under the Apache License, Version 2.0 (the "License");
- *   you may not use this file except in compliance with the License.
- *   You may obtain a copy of the License at
- *
- *       http://www.apache.org/licenses/LICENSE-2.0
- *
- *   Unless required by applicable law or agreed to in writing, software
- *   distributed under the License is distributed on an "AS IS" BASIS,
- *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *   See the License for the specific language governing permissions and
- *   limitations under the License.
  */
-
 package {{{pkgName}}};
 
 {{#imports}}

resources/javaTemplates/JavaClassTemplate.txt

@@ -1,21 +1,8 @@
 /**
- * Copyright (c) {{{year}}} Source Auditor Inc.
- *
+ * SPDX-FileCopyrightText: Copyright (c) {{{year}}} Source Auditor Inc.
+ * SPDX-FileType: SOURCE
  * SPDX-License-Identifier: Apache-2.0
- * 
- *   Licensed under the Apache License, Version 2.0 (the "License");
- *   you may not use this file except in compliance with the License.
- *   You may obtain a copy of the License at
- *
- *       http://www.apache.org/licenses/LICENSE-2.0
- *
- *   Unless required by applicable law or agreed to in writing, software
- *   distributed under the License is distributed on an "AS IS" BASIS,
- *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *   See the License for the specific language governing permissions and
- *   limitations under the License.
  */
-
 package {{{pkgName}}};
 
 {{#imports}}

resources/javaTemplates/LicenseSetEqualsOverrideTemplate.txt

@@ -1,4 +1,6 @@
 	/**
+	 * Get flatten license set
+	 *
 	 * License sets can contain other conjunctive license sets as members.  Logically,
 	 * the members of these "sub-conjunctive license sets" could be direct members and have the same
 	 * meaning.
@@ -121,4 +123,4 @@
 			}
 		}
 		return true;
-	}
+	}

resources/javaTemplates/MockCopyManagerTemplate.txt

@@ -1,6 +1,7 @@
 /**
+ * SPDX-FileCopyrightText: Copyright (c) {{{year}}} Source Auditor Inc.
+ * SPDX-FileType: SOURCE
  * SPDX-License-Identifier: Apache-2.0
- * Copyright (c) 2024 Source Auditor Inc.
  */
 package org.spdx.library.model.{{versionSuffix}};
 

resources/javaTemplates/MockModelStoreTemplate.txt

@@ -1,6 +1,7 @@
 /**
+ * SPDX-FileCopyrightText: Copyright (c) {{{year}}} Source Auditor Inc.
+ * SPDX-FileType: SOURCE
  * SPDX-License-Identifier: Apache-2.0
- * Copyright (c) 2024 Source Auditor Inc.
  */
 package org.spdx.library.model.{{versionSuffix}};
 

resources/javaTemplates/ModelClassFactoryTemplate.txt

@@ -1,22 +1,9 @@
 /**
- * Copyright (c) 2023 Source Auditor Inc.
- *
+ * SPDX-FileCopyrightText: Copyright (c) {{{year}}} Source Auditor Inc.
+ * SPDX-FileType: SOURCE
  * SPDX-License-Identifier: Apache-2.0
- * 
- *   Licensed under the Apache License, Version 2.0 (the "License");
- *   you may not use this file except in compliance with the License.
- *   You may obtain a copy of the License at
- *
- *       http://www.apache.org/licenses/LICENSE-2.0
- *
- *   Unless required by applicable law or agreed to in writing, software
- *   distributed under the License is distributed on an "AS IS" BASIS,
- *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *   See the License for the specific language governing permissions and
- *   limitations under the License.
  */
-
- package org.spdx.library.model.{{versionSuffix}};
+package org.spdx.library.model.{{versionSuffix}};
 
 import org.spdx.core.IModelCopyManager;
 import org.spdx.core.InvalidSPDXAnalysisException;
@@ -45,7 +32,6 @@ import javax.annotation.Nullable;
  * The <code>getModelObject</code> method will fetch or create a model object based on the URI for the class
  * 
  * @author Gary O'Neall
- *
  */
 public class SpdxModelClassFactoryV3 {
 

resources/javaTemplates/ModelInfoTemplate.txt

@@ -1,6 +1,7 @@
 /**
+ * SPDX-FileCopyrightText: Copyright (c) {{{year}}} Source Auditor Inc.
+ * SPDX-FileType: SOURCE
  * SPDX-License-Identifier: Apache-2.0
- * Copyright (c) 2024 Source Auditor Inc.
  */
 package org.spdx.library.model.{{versionSuffix}};
 

resources/javaTemplates/OrLaterToStringTemplate.txt

@@ -1,7 +1,7 @@
 try {
-			String subjectLicense = Objects.nonNull(this.{{{subjectLicenseGetter}}}()) ? 
-							this.{{{subjectLicenseGetter}}}().toString() : "[Missing Subject License]";
-			return subjectLicense + "+";
-		} catch (InvalidSPDXAnalysisException e) {
-			return "Error: "+e.getMessage();
-		}
+	String subjectLicense = Objects.nonNull(this.{{{subjectLicenseGetter}}}()) ? 
+		this.{{{subjectLicenseGetter}}}().toString() : "[Missing Subject License]";
+	return subjectLicense + "+";
+} catch (InvalidSPDXAnalysisException e) {
+	return "Error: " + e.getMessage();
+}

resources/javaTemplates/PackageInfoTemplate.txt

@@ -1,11 +1,12 @@
 /**
+ * SPDX-FileCopyrightText: Copyright (c) {{{year}}} Source Auditor Inc.
+ * SPDX-FileType: SOURCE
  * SPDX-License-Identifier: Apache-2.0
- * Copyright (c) 2024 Source Auditor Inc.
  */
+
 /**
  * @author Gary O'Neall
  * 
  * Version {{versionSemVer}} of the SPDX model
- *
  */
-package org.spdx.library.model.{{versionSuffix}};
+package org.spdx.library.model.{{versionSuffix}};

resources/javaTemplates/SpdxConstantsTemplate.txt

@@ -1,19 +1,7 @@
 /**
- * Copyright (c) 2023 Source Auditor Inc.
- *
+ * SPDX-FileCopyrightText: Copyright (c) {{{year}}} Source Auditor Inc.
+ * SPDX-FileType: SOURCE
  * SPDX-License-Identifier: Apache-2.0
- * 
- *   Licensed under the Apache License, Version 2.0 (the "License");
- *   you may not use this file except in compliance with the License.
- *   You may obtain a copy of the License at
- *
- *       http://www.apache.org/licenses/LICENSE-2.0
- *
- *   Unless required by applicable law or agreed to in writing, software
- *   distributed under the License is distributed on an "AS IS" BASIS,
- *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *   See the License for the specific language governing permissions and
- *   limitations under the License.
  */
 package org.spdx.library.model.{{versionSuffix}};
 
@@ -22,7 +10,6 @@ import org.spdx.storage.PropertyDescriptor;
 /**
  * Constants which map to the SPDX specifications
  * @author Gary O'Neall
- *
  */
 public class SpdxConstantsV3 {