Skip to content

Commit 4853312

Browse files
bactbact
committed
deploy: 662b4f8 
1 parent 237d757 commit 4853312

7 files changed

Lines changed: 71 additions & 18 deletions

‎index-all.html‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -851,7 +851,9 @@ <h2 class="title">G</h2>
851851
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
852852
&nbsp;</dd>
853853
<dt><span class="memberNameLink"><a href="org/spdx/utility/compare/LicenseCompareHelper.html#getFirstLicenseToken(java.lang.String)">getFirstLicenseToken(String)</a></span> - Static method in class org.spdx.utility.compare.<a href="org/spdx/utility/compare/LicenseCompareHelper.html" title="class in org.spdx.utility.compare">LicenseCompareHelper</a></dt>
854-
<dd>&nbsp;</dd>
854+
<dd>
855+
<div class="block">Return the first license token found in the given text</div>
856+
</dd>
855857
<dt><span class="memberNameLink"><a href="org/spdx/storage/listedlicense/LicenseJsonTOC.LicenseJson.html#getFsfLibre()">getFsfLibre()</a></span> - Method in class org.spdx.storage.listedlicense.<a href="org/spdx/storage/listedlicense/LicenseJsonTOC.LicenseJson.html" title="class in org.spdx.storage.listedlicense">LicenseJsonTOC.LicenseJson</a></dt>
856858
<dd>&nbsp;</dd>
857859
<dt><span class="memberNameLink"><a href="org/spdx/storage/listedlicense/CrossRefJson.html#getId()">getId()</a></span> - Method in class org.spdx.storage.listedlicense.<a href="org/spdx/storage/listedlicense/CrossRefJson.html" title="class in org.spdx.storage.listedlicense">CrossRefJson</a></dt>
@@ -1620,7 +1622,9 @@ <h2 class="title">I</h2>
16201622
<dt><span class="memberNameLink"><a href="org/spdx/utility/compare/SpdxItemDifference.html#isSeenLicensesEquals()">isSeenLicensesEquals()</a></span> - Method in class org.spdx.utility.compare.<a href="org/spdx/utility/compare/SpdxItemDifference.html" title="class in org.spdx.utility.compare">SpdxItemDifference</a></dt>
16211623
<dd>&nbsp;</dd>
16221624
<dt><span class="memberNameLink"><a href="org/spdx/utility/compare/LicenseCompareHelper.html#isSingleTokenString(java.lang.String)">isSingleTokenString(String)</a></span> - Static method in class org.spdx.utility.compare.<a href="org/spdx/utility/compare/LicenseCompareHelper.html" title="class in org.spdx.utility.compare">LicenseCompareHelper</a></dt>
1623-
<dd>&nbsp;</dd>
1625+
<dd>
1626+
<div class="block">Check whether the given text contains only a single token</div>
1627+
</dd>
16241628
<dt><span class="memberNameLink"><a href="org/spdx/utility/compare/SpdxSnippetComparer.html#isSnippetFromFilesEquals()">isSnippetFromFilesEquals()</a></span> - Method in class org.spdx.utility.compare.<a href="org/spdx/utility/compare/SpdxSnippetComparer.html" title="class in org.spdx.utility.compare">SpdxSnippetComparer</a></dt>
16251629
<dd>
16261630
<div class="block">The snippetFromFiles can be true if there are some unique snippetFromFiles or differences between the snippetFromFiles (or both)</div>
@@ -1670,7 +1674,10 @@ <h2 class="title">I</h2>
16701674
<dt><span class="memberNameLink"><a href="org/spdx/utility/compare/TemplateRegexMatcher.html#isTemplateMatchWithinText(java.lang.String)">isTemplateMatchWithinText(String)</a></span> - Method in class org.spdx.utility.compare.<a href="org/spdx/utility/compare/TemplateRegexMatcher.html" title="class in org.spdx.utility.compare">TemplateRegexMatcher</a></dt>
16711675
<dd>&nbsp;</dd>
16721676
<dt><span class="memberNameLink"><a href="org/spdx/utility/compare/LicenseCompareHelper.html#isTextMatchingTemplate(java.lang.String,java.lang.String)">isTextMatchingTemplate(String, String)</a></span> - Static method in class org.spdx.utility.compare.<a href="org/spdx/utility/compare/LicenseCompareHelper.html" title="class in org.spdx.utility.compare">LicenseCompareHelper</a></dt>
1673-
<dd>&nbsp;</dd>
1677+
<dd>
1678+
<div class="block">Compare the provided text against a license template using SPDX matching
1679+
guidelines</div>
1680+
</dd>
16741681
<dt><span class="memberNameLink"><a href="org/spdx/utility/compare/LicenseCompareHelper.html#isTextStandardException(org.spdx.library.model.v2.license.LicenseException,java.lang.String)">isTextStandardException(LicenseException, String)</a></span> - Static method in class org.spdx.utility.compare.<a href="org/spdx/utility/compare/LicenseCompareHelper.html" title="class in org.spdx.utility.compare">LicenseCompareHelper</a></dt>
16751682
<dd>
16761683
<div class="block">Compares exception text to the exception text of an SPDX Standard exception</div>
@@ -1841,7 +1848,8 @@ <h2 class="title">L</h2>
18411848
<dd>&nbsp;</dd>
18421849
<dt><span class="memberNameLink"><a href="org/spdx/utility/compare/LicenseCompareHelper.html#locateOriginalText(java.lang.String,int,int,java.util.Map,java.lang.String%5B%5D)">locateOriginalText(String, int, int, Map&lt;Integer, LineColumn&gt;, String[])</a></span> - Static method in class org.spdx.utility.compare.<a href="org/spdx/utility/compare/LicenseCompareHelper.html" title="class in org.spdx.utility.compare">LicenseCompareHelper</a></dt>
18431850
<dd>
1844-
<div class="block">Locate the original text starting with the start token and ending with the end token</div>
1851+
<div class="block">Locate the original text starting with the start token and ending with the
1852+
end token</div>
18451853
</dd>
18461854
</dl>
18471855
<a id="I:M">

‎member-search-index.zip‎

0 Bytes
Binary file not shown.

‎org/spdx/utility/compare/LicenseCompareHelper.html‎

Lines changed: 51 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,9 @@ <h3>Method Summary</h3>
211211
<tr id="i0" class="altColor">
212212
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
213213
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFirstLicenseToken(java.lang.String)">getFirstLicenseToken</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;text)</code></th>
214-
<td class="colLast">&nbsp;</td>
214+
<td class="colLast">
215+
<div class="block">Return the first license token found in the given text</div>
216+
</td>
215217
</tr>
216218
<tr id="i1" class="rowColor">
217219
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;</code></td>
@@ -285,7 +287,9 @@ <h3>Method Summary</h3>
285287
<tr id="i9" class="rowColor">
286288
<td class="colFirst"><code>static boolean</code></td>
287289
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSingleTokenString(java.lang.String)">isSingleTokenString</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;text)</code></th>
288-
<td class="colLast">&nbsp;</td>
290+
<td class="colLast">
291+
<div class="block">Check whether the given text contains only a single token</div>
292+
</td>
289293
</tr>
290294
<tr id="i10" class="altColor">
291295
<td class="colFirst"><code>static boolean</code></td>
@@ -323,7 +327,10 @@ <h3>Method Summary</h3>
323327
<td class="colFirst"><code>static <a href="CompareTemplateOutputHandler.DifferenceDescription.html" title="class in org.spdx.utility.compare">CompareTemplateOutputHandler.DifferenceDescription</a></code></td>
324328
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isTextMatchingTemplate(java.lang.String,java.lang.String)">isTextMatchingTemplate</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;template,
325329
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;compareText)</code></th>
326-
<td class="colLast">&nbsp;</td>
330+
<td class="colLast">
331+
<div class="block">Compare the provided text against a license template using SPDX matching
332+
guidelines</div>
333+
</td>
327334
</tr>
328335
<tr id="i15" class="rowColor">
329336
<td class="colFirst"><code>static <a href="CompareTemplateOutputHandler.DifferenceDescription.html" title="class in org.spdx.utility.compare">CompareTemplateOutputHandler.DifferenceDescription</a></code></td>
@@ -372,7 +379,8 @@ <h3>Method Summary</h3>
372379
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>,&#8203;org.spdx.licenseTemplate.LineColumn&gt;&nbsp;tokenToLocation,
373380
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]&nbsp;tokens)</code></th>
374381
<td class="colLast">
375-
<div class="block">Locate the original text starting with the start token and ending with the end token</div>
382+
<div class="block">Locate the original text starting with the start token and ending with the
383+
end token</div>
376384
</td>
377385
</tr>
378386
<tr id="i21" class="rowColor">
@@ -541,15 +549,17 @@ <h4>locateOriginalText</h4>
541549
int&nbsp;endToken,
542550
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>,&#8203;org.spdx.licenseTemplate.LineColumn&gt;&nbsp;tokenToLocation,
543551
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]&nbsp;tokens)</pre>
544-
<div class="block">Locate the original text starting with the start token and ending with the end token</div>
552+
<div class="block">Locate the original text starting with the start token and ending with the
553+
end token</div>
545554
<dl>
546555
<dt><span class="paramLabel">Parameters:</span></dt>
547556
<dd><code>fullLicenseText</code> - entire license text</dd>
548557
<dd><code>startToken</code> - starting token</dd>
549558
<dd><code>endToken</code> - ending token</dd>
550559
<dd><code>tokenToLocation</code> - token location</dd>
551560
<dt><span class="returnLabel">Returns:</span></dt>
552-
<dd>original text starting with the start token and ending with the end token</dd>
561+
<dd>original text starting with the start token and ending with the end
562+
token</dd>
553563
</dl>
554564
</li>
555565
</ul>
@@ -559,7 +569,24 @@ <h4>locateOriginalText</h4>
559569
<ul class="blockList">
560570
<li class="blockList">
561571
<h4>getFirstLicenseToken</h4>
562-
<pre class="methodSignature">public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getFirstLicenseToken&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;text)</pre>
572+
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation" class="externalLink">@Nullable</a>
573+
public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getFirstLicenseToken&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation" class="externalLink">@Nullable</a>
574+
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;text)</pre>
575+
<div class="block">Return the first license token found in the given text
576+
<p>
577+
The method normalizes the input text, removes comment characters,
578+
and splits it into tokens
579+
using <code>LicenseTextHelper.TOKEN_SPLIT_PATTERN</code>.
580+
It returns the first non-empty token found,
581+
or <code>null</code> if no such token exists.
582+
</p></div>
583+
<dl>
584+
<dt><span class="paramLabel">Parameters:</span></dt>
585+
<dd><code>text</code> - The license text to extract the first token from.</dd>
586+
<dt><span class="returnLabel">Returns:</span></dt>
587+
<dd>The first non-empty token as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>String</code></a>,
588+
or <code>null</code> if none is found.</dd>
589+
</dl>
563590
</li>
564591
</ul>
565592
<a id="isSingleTokenString(java.lang.String)">
@@ -568,12 +595,21 @@ <h4>getFirstLicenseToken</h4>
568595
<ul class="blockList">
569596
<li class="blockList">
570597
<h4>isSingleTokenString</h4>
571-
<pre class="methodSignature">public static&nbsp;boolean&nbsp;isSingleTokenString&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;text)</pre>
598+
<pre class="methodSignature">public static&nbsp;boolean&nbsp;isSingleTokenString&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation" class="externalLink">@Nullable</a>
599+
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;text)</pre>
600+
<div class="block">Check whether the given text contains only a single token
601+
<p>
602+
A single token string is a string that contains zero or one token,
603+
as identified by the <code>LicenseTextHelper.TOKEN_SPLIT_PATTERN</code>.
604+
Whitespace and punctuation such as dots, commas, question marks,
605+
and quotation marks are ignored.
606+
</p></div>
572607
<dl>
573608
<dt><span class="paramLabel">Parameters:</span></dt>
574-
<dd><code>text</code> - text to test</dd>
609+
<dd><code>text</code> - The text to test.</dd>
575610
<dt><span class="returnLabel">Returns:</span></dt>
576-
<dd>true if the text contains a single token</dd>
611+
<dd><code>true</code> if the text contains zero or one token,
612+
<code>false</code> otherwise.</dd>
577613
</dl>
578614
</li>
579615
</ul>
@@ -656,12 +692,15 @@ <h4>isTextMatchingTemplate</h4>
656692
<pre class="methodSignature">public static&nbsp;<a href="CompareTemplateOutputHandler.DifferenceDescription.html" title="class in org.spdx.utility.compare">CompareTemplateOutputHandler.DifferenceDescription</a>&nbsp;isTextMatchingTemplate&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;template,
657693
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;compareText)
658694
throws <a href="SpdxCompareException.html" title="class in org.spdx.utility.compare">SpdxCompareException</a></pre>
695+
<div class="block">Compare the provided text against a license template using SPDX matching
696+
guidelines</div>
659697
<dl>
660698
<dt><span class="paramLabel">Parameters:</span></dt>
661-
<dd><code>template</code> - Template in the standard template format used for comparison</dd>
699+
<dd><code>template</code> - Template in the standard template format used for
700+
comparison</dd>
662701
<dd><code>compareText</code> - Text to compare using the template</dd>
663702
<dt><span class="returnLabel">Returns:</span></dt>
664-
<dd>any differences found</dd>
703+
<dd>Any differences found</dd>
665704
<dt><span class="throwsLabel">Throws:</span></dt>
666705
<dd><code><a href="SpdxCompareException.html" title="class in org.spdx.utility.compare">SpdxCompareException</a></code> - on comparison errors</dd>
667706
</dl>

‎org/spdx/utility/compare/class-use/CompareTemplateOutputHandler.DifferenceDescription.html‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,10 @@ <h3>Uses of <a href="../CompareTemplateOutputHandler.DifferenceDescription.html"
141141
<td class="colFirst"><code>static <a href="../CompareTemplateOutputHandler.DifferenceDescription.html" title="class in org.spdx.utility.compare">CompareTemplateOutputHandler.DifferenceDescription</a></code></td>
142142
<th class="colSecond" scope="row"><span class="typeNameLabel">LicenseCompareHelper.</span><code><span class="memberNameLink"><a href="../LicenseCompareHelper.html#isTextMatchingTemplate(java.lang.String,java.lang.String)">isTextMatchingTemplate</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;template,
143143
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;compareText)</code></th>
144-
<td class="colLast">&nbsp;</td>
144+
<td class="colLast">
145+
<div class="block">Compare the provided text against a license template using SPDX matching
146+
guidelines</div>
147+
</td>
145148
</tr>
146149
<tr class="altColor">
147150
<td class="colFirst"><code>static <a href="../CompareTemplateOutputHandler.DifferenceDescription.html" title="class in org.spdx.utility.compare">CompareTemplateOutputHandler.DifferenceDescription</a></code></td>

‎org/spdx/utility/compare/class-use/SpdxCompareException.html‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -743,7 +743,10 @@ <h3>Uses of <a href="../SpdxCompareException.html" title="class in org.spdx.util
743743
<td class="colFirst"><code>static <a href="../CompareTemplateOutputHandler.DifferenceDescription.html" title="class in org.spdx.utility.compare">CompareTemplateOutputHandler.DifferenceDescription</a></code></td>
744744
<th class="colSecond" scope="row"><span class="typeNameLabel">LicenseCompareHelper.</span><code><span class="memberNameLink"><a href="../LicenseCompareHelper.html#isTextMatchingTemplate(java.lang.String,java.lang.String)">isTextMatchingTemplate</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;template,
745745
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;compareText)</code></th>
746-
<td class="colLast">&nbsp;</td>
746+
<td class="colLast">
747+
<div class="block">Compare the provided text against a license template using SPDX matching
748+
guidelines</div>
749+
</td>
747750
</tr>
748751
<tr class="altColor">
749752
<td class="colFirst"><code>static <a href="../CompareTemplateOutputHandler.DifferenceDescription.html" title="class in org.spdx.utility.compare">CompareTemplateOutputHandler.DifferenceDescription</a></code></td>

‎package-search-index.zip‎

0 Bytes
Binary file not shown.

‎type-search-index.zip‎

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)