Add SPDX header to source files

Signed-off-by: Arthit Suriyawongkul <[email protected]>
spdx · Feb 3, 2025 · 44d8c55 · 44d8c55
1 parent 93f7b35
commit 44d8c55
Show file tree

Hide file tree

Showing 33 changed files with 295 additions and 228 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,15 +1,18 @@
 Contributing
 ============
+
 Thank you for your interest in `spdx-java-spreadsheet-store`. The project is open-source software, and bug reports, suggestions, and most especially patches are welcome.
 
 Issues
 ------
+
 `spdx-java-spreadsheet-store` has a [project page on GitHub](https://github.com/spdx/spdx-java-spreadsheet-store) where you can [create an issue](https://github.com/spdx/spdx-java-spreadsheet-store/issues) to report a bug, make a suggestion, or propose a substantial change or improvement that you might like to make. You may also wish to contact the SPDX working group technical team through its mailing list, [[email protected]](mailto:[email protected]).
 
 If you would like to work on a fix for any issue, please assign the issue to yourself prior to creating a Pull Request.
 
 Pull Requests
 -------
+
 The source code for `spdx-java-spreadsheet-store` is hosted on [github.com/spdx/spdx-java-spreadsheet-store](https://github.com/spdx/spdx-java-spreadsheet-store). Please review [open pull requests](https://github.com/spdx/spdx-java-spreadsheet-store/pulls) and [active branches](https://github.com/spdx/spdx-java-spreadsheet-store/branches) before committing time to a substantial revision. Work along similar lines may already be in progress.
 
 To submit a pull request via GitHub, fork the repository, create a topic branch from `master` for your work, and send a pull request when ready. If you would prefer to send a patch or grant access to pull from your own Git repository, please contact the project's contributors by e-mail.
@@ -20,4 +23,5 @@ Once implemented, submit a pull request with `spec/X.X` branch as the parent bra
 
 Licensing
 ---------
-However you choose to contribute, please sign-off in each of your commits that you license your contributions under the terms of [the Developer Certificate of Origin](https://developercertificate.org/). Git has utilities for signing off on commits: `git commit -s` signs a current commit, and `git rebase --signoff <revision-range>` retroactively signs a range of past commits.
+
+However you choose to contribute, please sign-off in each of your commits that you license your contributions under the terms of [the Developer Certificate of Origin](https://developercertificate.org/). Git has utilities for signing off on commits: `git commit -s` signs a current commit, and `git rebase --signoff <revision-range>` retroactively signs a range of past commits.
diff --git a/README.md b/README.md
@@ -1,11 +1,12 @@
 # spdx-java-spreadsheet-store
+
 Stores SPDX documents in Microsoft Excel formats.  Supports both XLS and XLSX file types.
 
 This store supports serializing and deserializing files in XLS and XLSX spreadsheet formats.
 
 This library utilizes the [SPDX Java Library Storage Interface](https://github.com/spdx/Spdx-Java-Library#storage-interface) extending the `ExtendedSpdxStore` which allows for utilizing any underlying store which implements the [SPDX Java Library Storage Interface](https://github.com/spdx/Spdx-Java-Library#storage-interface).
 
-# Using the Library
+## Using the Library
 
 This library is intended to be used in conjunction with the [SPDX Java Library](https://github.com/spdx/Spdx-Java-Library).
 
@@ -16,10 +17,10 @@ Create an instance of `SpreadsheetStore(IModelStore baseStore, SpreadsheetFormat
 - `XLS` - Microsoft Excel 97 to 2003 Workbook format
 - `XLSX` - Microsoft Excel workbook format
 
-# Serializing and Deserializing
+## Serializing and Deserializing
 
 This library supports the `ISerializableModelStore` interface for serializing and deserializing files based on the format specified.
 
-# Development Status
+## Development Status
 
-Mostly stable - although it has not been widely used.
+Mostly stable - although it has not been widely used.
diff --git a/src/main/java/org/spdx/spreadsheetstore/AbstractSheet.java b/src/main/java/org/spdx/spreadsheetstore/AbstractSheet.java
@@ -1,14 +1,15 @@
-/**
- * Copyright (c) 2020 Source Auditor Inc.
- *
+/*
+ * SPDX-FileContributor: Gary O'Neall
+ * SPDX-FileCopyrightText: Copyright (c) 2020 Source Auditor Inc.
+ * SPDX-FileType: SOURCE
  * SPDX-License-Identifier: Apache-2.0
- * 
+ * <p>
  *   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
- *
+ * <p>
+ *       https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
  *   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.

diff --git a/src/main/java/org/spdx/spreadsheetstore/AnnotationsSheet.java b/src/main/java/org/spdx/spreadsheetstore/AnnotationsSheet.java
@@ -1,14 +1,15 @@
-/**
- * Copyright (c) 2020 Source Auditor Inc.
- *
+/*
+ * SPDX-FileContributor: Gary O'Neall
+ * SPDX-FileCopyrightText: Copyright (c) 2020 Source Auditor Inc.
+ * SPDX-FileType: SOURCE
  * SPDX-License-Identifier: Apache-2.0
- * 
+ * <p>
  *   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
- *
+ * <p>
+ *       https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
  *   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.

diff --git a/src/main/java/org/spdx/spreadsheetstore/DocumentInfoSheet.java b/src/main/java/org/spdx/spreadsheetstore/DocumentInfoSheet.java
@@ -1,14 +1,15 @@
-/**
- * Copyright (c) 2020 Source Auditor Inc.
- *
+/*
+ * SPDX-FileContributor: Gary O'Neall
+ * SPDX-FileCopyrightText: Copyright (c) 2020 Source Auditor Inc.
+ * SPDX-FileType: SOURCE
  * SPDX-License-Identifier: Apache-2.0
- * 
+ * <p>
  *   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
- *
+ * <p>
+ *       https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
  *   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.
@@ -33,9 +34,9 @@
 
 /**
  * Abstract class for sheet containing information about the origins of an SPDX document
+ *
  * Specific versions implemented as subclasses
  * @author Gary O'Neall
- *
  */
 public abstract class DocumentInfoSheet extends AbstractSheet {
 	static final int SPREADSHEET_VERSION_COL = 0;

diff --git a/src/main/java/org/spdx/spreadsheetstore/DocumentInfoSheetV2d0.java b/src/main/java/org/spdx/spreadsheetstore/DocumentInfoSheetV2d0.java
@@ -1,14 +1,15 @@
-/**
- * Copyright (c) 2020 Source Auditor Inc.
- *
+/*
+ * SPDX-FileContributor: Gary O'Neall
+ * SPDX-FileCopyrightText: Copyright (c) 2020 Source Auditor Inc.
+ * SPDX-FileType: SOURCE
  * SPDX-License-Identifier: Apache-2.0
- * 
+ * <p>
  *   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
- *
+ * <p>
+ *       https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
  *   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.

diff --git a/src/main/java/org/spdx/spreadsheetstore/ExternalRefsSheet.java b/src/main/java/org/spdx/spreadsheetstore/ExternalRefsSheet.java
@@ -1,14 +1,15 @@
-/**
- * Copyright (c) 2020 Source Auditor Inc.
- *
+/*
+ * SPDX-FileContributor: Gary O'Neall
+ * SPDX-FileCopyrightText: Copyright (c) 2020 Source Auditor Inc.
+ * SPDX-FileType: SOURCE
  * SPDX-License-Identifier: Apache-2.0
- * 
+ * <p>
  *   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
- *
+ * <p>
+ *       https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
  *   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.

diff --git a/src/main/java/org/spdx/spreadsheetstore/ExtractedLicenseInfoSheet.java b/src/main/java/org/spdx/spreadsheetstore/ExtractedLicenseInfoSheet.java
@@ -1,14 +1,15 @@
-/**
- * Copyright (c) 2020 Source Auditor Inc.
- *
+/*
+ * SPDX-FileContributor: Gary O'Neall
+ * SPDX-FileCopyrightText: Copyright (c) 2020 Source Auditor Inc.
+ * SPDX-FileType: SOURCE
  * SPDX-License-Identifier: Apache-2.0
- * 
+ * <p>
  *   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
- *
+ * <p>
+ *       https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
  *   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.

diff --git a/src/main/java/org/spdx/spreadsheetstore/ExtractedLicenseInfoSheetV1d1.java b/src/main/java/org/spdx/spreadsheetstore/ExtractedLicenseInfoSheetV1d1.java
@@ -1,14 +1,15 @@
-/**
- * Copyright (c) 2020 Source Auditor Inc.
- *
+/*
+ * SPDX-FileContributor: Gary O'Neall
+ * SPDX-FileCopyrightText: Copyright (c) 2020 Source Auditor Inc.
+ * SPDX-FileType: SOURCE
  * SPDX-License-Identifier: Apache-2.0
- * 
+ * <p>
  *   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
- *
+ * <p>
+ *       https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
  *   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.

diff --git a/src/main/java/org/spdx/spreadsheetstore/PackageInfoSheet.java b/src/main/java/org/spdx/spreadsheetstore/PackageInfoSheet.java
@@ -1,14 +1,15 @@
-/**
- * Copyright (c) 2020 Source Auditor Inc.
- *
+/*
+ * SPDX-FileContributor: Gary O'Neall
+ * SPDX-FileCopyrightText: Copyright (c) 2020 Source Auditor Inc.
+ * SPDX-FileType: SOURCE
  * SPDX-License-Identifier: Apache-2.0
- * 
+ * <p>
  *   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
- *
+ * <p>
+ *       https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
  *   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.

diff --git a/src/main/java/org/spdx/spreadsheetstore/PackageInfoSheetV2d0.java b/src/main/java/org/spdx/spreadsheetstore/PackageInfoSheetV2d0.java
@@ -1,14 +1,15 @@
-/**
- * Copyright (c) 2020 Source Auditor Inc.
- *
+/*
+ * SPDX-FileContributor: Gary O'Neall
+ * SPDX-FileCopyrightText: Copyright (c) 2020 Source Auditor Inc.
+ * SPDX-FileType: SOURCE
  * SPDX-License-Identifier: Apache-2.0
- * 
+ * <p>
  *   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
- *
+ * <p>
+ *       https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
  *   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.

diff --git a/src/main/java/org/spdx/spreadsheetstore/PackageInfoSheetV2d1.java b/src/main/java/org/spdx/spreadsheetstore/PackageInfoSheetV2d1.java
@@ -1,14 +1,15 @@
-/**
- * Copyright (c) 2020 Source Auditor Inc.
- *
+/*
+ * SPDX-FileContributor: Gary O'Neall
+ * SPDX-FileCopyrightText: Copyright (c) 2020 Source Auditor Inc.
+ * SPDX-FileType: SOURCE
  * SPDX-License-Identifier: Apache-2.0
- * 
+ * <p>
  *   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
- *
+ * <p>
+ *       https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
  *   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.

diff --git a/src/main/java/org/spdx/spreadsheetstore/PackageInfoSheetV2d2.java b/src/main/java/org/spdx/spreadsheetstore/PackageInfoSheetV2d2.java
@@ -1,14 +1,15 @@
-/**
- * Copyright (c) 2020 Source Auditor Inc.
- *
+/*
+ * SPDX-FileContributor: Gary O'Neall
+ * SPDX-FileCopyrightText: Copyright (c) 2020 Source Auditor Inc.
+ * SPDX-FileType: SOURCE
  * SPDX-License-Identifier: Apache-2.0
- * 
+ * <p>
  *   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
- *
+ * <p>
+ *       https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
  *   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.

diff --git a/src/main/java/org/spdx/spreadsheetstore/PackageInfoSheetV2d3.java b/src/main/java/org/spdx/spreadsheetstore/PackageInfoSheetV2d3.java
@@ -1,14 +1,15 @@
-/**
- * Copyright (c) 2020 Source Auditor Inc.
- *
+/*
+ * SPDX-FileContributor: Gary O'Neall
+ * SPDX-FileCopyrightText: Copyright (c) 2020 Source Auditor Inc.
+ * SPDX-FileType: SOURCE
  * SPDX-License-Identifier: Apache-2.0
- * 
+ * <p>
  *   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
- *
+ * <p>
+ *       https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
  *   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.

diff --git a/src/main/java/org/spdx/spreadsheetstore/PerFileSheet.java b/src/main/java/org/spdx/spreadsheetstore/PerFileSheet.java
@@ -1,14 +1,15 @@
-/**
- * Copyright (c) 2020 Source Auditor Inc.
- *
+/*
+ * SPDX-FileContributor: Gary O'Neall
+ * SPDX-FileCopyrightText: Copyright (c) 2020 Source Auditor Inc.
+ * SPDX-FileType: SOURCE
  * SPDX-License-Identifier: Apache-2.0
- * 
+ * <p>
  *   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
- *
+ * <p>
+ *       https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
  *   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.

diff --git a/src/main/java/org/spdx/spreadsheetstore/PerFileSheetV2d0.java b/src/main/java/org/spdx/spreadsheetstore/PerFileSheetV2d0.java
@@ -1,14 +1,15 @@
-/**
- * Copyright (c) 2020 Source Auditor Inc.
- *
+/*
+ * SPDX-FileContributor: Gary O'Neall
+ * SPDX-FileCopyrightText: Copyright (c) 2020 Source Auditor Inc.
+ * SPDX-FileType: SOURCE
  * SPDX-License-Identifier: Apache-2.0
- * 
+ * <p>
  *   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
- *
+ * <p>
+ *       https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
  *   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.