deploy: e6ffecf

Author: goneall

allclasses-index.html

@@ -258,7 +258,9 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
 <div class="block">Static helper methods for the various tools</div>
 </div>
 <div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="org/spdx/tools/SpdxToolsHelper.SerFileType.html" title="enum in org.spdx.tools">SpdxToolsHelper.SerFileType</a></div>
-<div class="col-last even-row-color all-classes-table all-classes-table-tab3">&nbsp;</div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab3">
+<div class="block">Supported serialization file types</div>
+</div>
 <div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="org/spdx/tools/SpdxVerificationException.html" title="class in org.spdx.tools">SpdxVerificationException</a></div>
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab5">
 <div class="block">Exceptions for the SPDX Verify tools</div>

index-all.html

@@ -209,13 +209,23 @@ <h2 class="title" id="I:D">D</h2>
 <dt><a href="org/spdx/tools/compare/PackageSheet.html#DESCRIPTION_FIELD_TEXT" class="member-name-link">DESCRIPTION_FIELD_TEXT</a> - Static variable in class org.spdx.tools.compare.<a href="org/spdx/tools/compare/PackageSheet.html" title="class in org.spdx.tools.compare">PackageSheet</a></dt>
 <dd>&nbsp;</dd>
 <dt><a href="org/spdx/tools/SpdxToolsHelper.html#deserializeDocument(java.io.File,org.spdx.tools.SpdxToolsHelper.SerFileType)" class="member-name-link">deserializeDocument(File, SpdxToolsHelper.SerFileType)</a> - Static method in class org.spdx.tools.<a href="org/spdx/tools/SpdxToolsHelper.html" title="class in org.spdx.tools">SpdxToolsHelper</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Deserializes an SPDX document from a file</div>
+</dd>
 <dt><a href="org/spdx/tools/SpdxToolsHelper.html#deserializeDocumentCompat(java.io.File)" class="member-name-link">deserializeDocumentCompat(File)</a> - Static method in class org.spdx.tools.<a href="org/spdx/tools/SpdxToolsHelper.html" title="class in org.spdx.tools">SpdxToolsHelper</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Deserializes an SPDX document from a file</div>
+</dd>
 <dt><a href="org/spdx/tools/SpdxToolsHelper.html#deserializeDocumentCompatV2(java.io.File)" class="member-name-link">deserializeDocumentCompatV2(File)</a> - Static method in class org.spdx.tools.<a href="org/spdx/tools/SpdxToolsHelper.html" title="class in org.spdx.tools">SpdxToolsHelper</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Deserializes an SPDX document from a file,
+ compatible with SPDX version 2</div>
+</dd>
 <dt><a href="org/spdx/tools/SpdxToolsHelper.html#deserializeDocumentCompatV2(java.io.File,org.spdx.tools.SpdxToolsHelper.SerFileType)" class="member-name-link">deserializeDocumentCompatV2(File, SpdxToolsHelper.SerFileType)</a> - Static method in class org.spdx.tools.<a href="org/spdx/tools/SpdxToolsHelper.html" title="class in org.spdx.tools">SpdxToolsHelper</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Deserializes an SPDX document from a file,
+ compatible with SPDX version 2</div>
+</dd>
 <dt><a href="org/spdx/tools/SpdxToolsHelper.html#deserializeFile(org.spdx.storage.ISerializableModelStore,java.io.File)" class="member-name-link">deserializeFile(ISerializableModelStore, File)</a> - Static method in class org.spdx.tools.<a href="org/spdx/tools/SpdxToolsHelper.html" title="class in org.spdx.tools">SpdxToolsHelper</a></dt>
 <dd>
 <div class="block">Reads SPDX data from a file and stores it in the store</div>
@@ -446,7 +456,9 @@ <h2 class="title" id="I:F">F</h2>
 <dt><a href="org/spdx/tools/compare/FileSpdxIdSheet.html#%3Cinit%3E(org.apache.poi.ss.usermodel.Workbook,java.lang.String)" class="member-name-link">FileSpdxIdSheet(Workbook, String)</a> - Constructor for class org.spdx.tools.compare.<a href="org/spdx/tools/compare/FileSpdxIdSheet.html" title="class in org.spdx.tools.compare">FileSpdxIdSheet</a></dt>
 <dd>&nbsp;</dd>
 <dt><a href="org/spdx/tools/SpdxToolsHelper.html#fileToFileType(java.io.File)" class="member-name-link">fileToFileType(File)</a> - Static method in class org.spdx.tools.<a href="org/spdx/tools/SpdxToolsHelper.html" title="class in org.spdx.tools">SpdxToolsHelper</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Determine the file type based on the file name and extension</div>
+</dd>
 <dt><a href="org/spdx/tools/compare/MultiDocumentSpreadsheet.html#fileTypeSheet" class="member-name-link">fileTypeSheet</a> - Variable in class org.spdx.tools.compare.<a href="org/spdx/tools/compare/MultiDocumentSpreadsheet.html" title="class in org.spdx.tools.compare">MultiDocumentSpreadsheet</a></dt>
 <dd>&nbsp;</dd>
 <dt><a href="org/spdx/tools/compare/FileTypeSheet.html" class="type-name-link" title="class in org.spdx.tools.compare">FileTypeSheet</a> - Class in <a href="org/spdx/tools/compare/package-summary.html">org.spdx.tools.compare</a></dt>
@@ -458,7 +470,10 @@ <h2 class="title" id="I:F">F</h2>
 <dt><a href="org/spdx/tools/compare/CompareHelper.html#fileTypesToString(org.spdx.library.model.v2.enumerations.FileType%5B%5D)" class="member-name-link">fileTypesToString(FileType[])</a> - Static method in class org.spdx.tools.compare.<a href="org/spdx/tools/compare/CompareHelper.html" title="class in org.spdx.tools.compare">CompareHelper</a></dt>
 <dd>&nbsp;</dd>
 <dt><a href="org/spdx/tools/SpdxToolsHelper.html#fileTypeToStore(org.spdx.tools.SpdxToolsHelper.SerFileType)" class="member-name-link">fileTypeToStore(SpdxToolsHelper.SerFileType)</a> - Static method in class org.spdx.tools.<a href="org/spdx/tools/SpdxToolsHelper.html" title="class in org.spdx.tools">SpdxToolsHelper</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Determine the appropriate in memory based model store which supports
+ serialization for the fileType</div>
+</dd>
 <dt><a href="org/spdx/tools/compare/PackageSheet.html#FIRST_DOC_COL" class="member-name-link">FIRST_DOC_COL</a> - Static variable in class org.spdx.tools.compare.<a href="org/spdx/tools/compare/PackageSheet.html" title="class in org.spdx.tools.compare">PackageSheet</a></dt>
 <dd>&nbsp;</dd>
 <dt><a href="org/spdx/tools/compare/SnippetSheet.html#FIRST_DOC_COL" class="member-name-link">FIRST_DOC_COL</a> - Static variable in class org.spdx.tools.compare.<a href="org/spdx/tools/compare/SnippetSheet.html" title="class in org.spdx.tools.compare">SnippetSheet</a></dt>
@@ -487,9 +502,14 @@ <h2 class="title" id="I:G">G</h2>
 <div class="block">Getter for the current tool Version</div>
 </dd>
 <dt><a href="org/spdx/tools/SpdxToolsHelper.html#getDocFromStore(org.spdx.storage.ISerializableModelStore)" class="member-name-link">getDocFromStore(ISerializableModelStore)</a> - Static method in class org.spdx.tools.<a href="org/spdx/tools/SpdxToolsHelper.html" title="class in org.spdx.tools">SpdxToolsHelper</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Gets an SPDX document from the model store</div>
+</dd>
 <dt><a href="org/spdx/tools/SpdxToolsHelper.html#getDocFromStoreCompatV2(org.spdx.storage.ISerializableModelStore)" class="member-name-link">getDocFromStoreCompatV2(ISerializableModelStore)</a> - Static method in class org.spdx.tools.<a href="org/spdx/tools/SpdxToolsHelper.html" title="class in org.spdx.tools">SpdxToolsHelper</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Gets an SPDX document from the model store,
+ compatible with SPDX version 2</div>
+</dd>
 <dt><a href="org/spdx/tools/compare/MultiDocumentSpreadsheet.html#getDocumentSheet()" class="member-name-link">getDocumentSheet()</a> - Method in class org.spdx.tools.compare.<a href="org/spdx/tools/compare/MultiDocumentSpreadsheet.html" title="class in org.spdx.tools.compare">MultiDocumentSpreadsheet</a></dt>
 <dd>&nbsp;</dd>
 <dt><a href="org/spdx/tools/compare/AbstractSheet.html#getFirstDataRow()" class="member-name-link">getFirstDataRow()</a> - Method in class org.spdx.tools.compare.<a href="org/spdx/tools/compare/AbstractSheet.html" title="class in org.spdx.tools.compare">AbstractSheet</a></dt>
@@ -789,7 +809,8 @@ <h2 class="title" id="I:R">R</h2>
 </dd>
 <dt><a href="org/spdx/tools/SpdxToolsHelper.html#readDocumentFromFileCompatV2(org.spdx.storage.ISerializableModelStore,java.io.File)" class="member-name-link">readDocumentFromFileCompatV2(ISerializableModelStore, File)</a> - Static method in class org.spdx.tools.<a href="org/spdx/tools/SpdxToolsHelper.html" title="class in org.spdx.tools">SpdxToolsHelper</a></dt>
 <dd>
-<div class="block">Reads an SPDX Document from a file</div>
+<div class="block">Reads an SPDX Document from a file,
+ compatible with SPDX version 2</div>
 </dd>
 <dt><a href="org/spdx/tools/SpdxToolsHelper.html#readDocumentFromFileV3(org.spdx.storage.ISerializableModelStore,java.io.File)" class="member-name-link">readDocumentFromFileV3(ISerializableModelStore, File)</a> - Static method in class org.spdx.tools.<a href="org/spdx/tools/SpdxToolsHelper.html" title="class in org.spdx.tools">SpdxToolsHelper</a></dt>
 <dd>
@@ -884,7 +905,9 @@ <h2 class="title" id="I:S">S</h2>
 <dt><a href="org/spdx/tools/SpdxToolsHelper.html#%3Cinit%3E()" class="member-name-link">SpdxToolsHelper()</a> - Constructor for class org.spdx.tools.<a href="org/spdx/tools/SpdxToolsHelper.html" title="class in org.spdx.tools">SpdxToolsHelper</a></dt>
 <dd>&nbsp;</dd>
 <dt><a href="org/spdx/tools/SpdxToolsHelper.SerFileType.html" class="type-name-link" title="enum in org.spdx.tools">SpdxToolsHelper.SerFileType</a> - Enum in <a href="org/spdx/tools/package-summary.html">org.spdx.tools</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Supported serialization file types</div>
+</dd>
 <dt><a href="org/spdx/tools/SpdxVerificationException.html" class="type-name-link" title="class in org.spdx.tools">SpdxVerificationException</a> - Exception in <a href="org/spdx/tools/package-summary.html">org.spdx.tools</a></dt>
 <dd>
 <div class="block">Exceptions for the SPDX Verify tools</div>
@@ -912,15 +935,21 @@ <h2 class="title" id="I:S">S</h2>
 <dt><a href="org/spdx/tools/SpdxViewer.html#%3Cinit%3E()" class="member-name-link">SpdxViewer()</a> - Constructor for class org.spdx.tools.<a href="org/spdx/tools/SpdxViewer.html" title="class in org.spdx.tools">SpdxViewer</a></dt>
 <dd>&nbsp;</dd>
 <dt><a href="org/spdx/tools/SpdxToolsHelper.html#strToFileType(java.lang.String)" class="member-name-link">strToFileType(String)</a> - Static method in class org.spdx.tools.<a href="org/spdx/tools/SpdxToolsHelper.html" title="class in org.spdx.tools">SpdxToolsHelper</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Determine the file type based on the file extension or string</div>
+</dd>
 <dt><a href="org/spdx/tools/compare/PackageSheet.html#SUMMARY_FIELD_TEXT" class="member-name-link">SUMMARY_FIELD_TEXT</a> - Static variable in class org.spdx.tools.compare.<a href="org/spdx/tools/compare/PackageSheet.html" title="class in org.spdx.tools.compare">PackageSheet</a></dt>
 <dd>&nbsp;</dd>
 <dt><a href="org/spdx/tools/compare/PackageSheet.html#SUPPLIER_FIELD_TEXT" class="member-name-link">SUPPLIER_FIELD_TEXT</a> - Static variable in class org.spdx.tools.compare.<a href="org/spdx/tools/compare/PackageSheet.html" title="class in org.spdx.tools.compare">PackageSheet</a></dt>
 <dd>&nbsp;</dd>
 <dt><a href="org/spdx/tools/SpdxToolsHelper.html#supportsV2(org.spdx.storage.ISerializableModelStore)" class="member-name-link">supportsV2(ISerializableModelStore)</a> - Static method in class org.spdx.tools.<a href="org/spdx/tools/SpdxToolsHelper.html" title="class in org.spdx.tools">SpdxToolsHelper</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Is the store supporting SPDX version 2</div>
+</dd>
 <dt><a href="org/spdx/tools/SpdxToolsHelper.html#supportsV3(org.spdx.storage.ISerializableModelStore)" class="member-name-link">supportsV3(ISerializableModelStore)</a> - Static method in class org.spdx.tools.<a href="org/spdx/tools/SpdxToolsHelper.html" title="class in org.spdx.tools">SpdxToolsHelper</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Is the store supporting SPDX version 3</div>
+</dd>
 </dl>
 <h2 class="title" id="I:T">T</h2>
 <dl class="index">

org/spdx/tools/SpdxToolsHelper.SerFileType.html

@@ -88,6 +88,7 @@ <h1 title="Enum SpdxToolsHelper.SerFileType" class="title">Enum SpdxToolsHelper.
 <hr>
 <div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name type-name-label">SpdxToolsHelper.SerFileType</span>
 <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;<a href="SpdxToolsHelper.SerFileType.html" title="enum in org.spdx.tools">SpdxToolsHelper.SerFileType</a>&gt;</span></div>
+<div class="block">Supported serialization file types</div>
 </section>
 <section class="summary">
 <ul class="summary-list">