Skip to content

Commit 69fcc10

Browse files
committed
deploy: 92ca695
1 parent d34a565 commit 69fcc10

7 files changed

Lines changed: 68 additions & 10 deletions

File tree

index-all.html

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -875,7 +875,9 @@ <h2 class="title">G</h2>
875875
<dt><span class="memberNameLink"><a href="org/spdx/storage/simple/InMemSpdxStore.html#getIdType(java.lang.String)">getIdType(String)</a></span> - Method in class org.spdx.storage.simple.<a href="org/spdx/storage/simple/InMemSpdxStore.html" title="class in org.spdx.storage.simple">InMemSpdxStore</a></dt>
876876
<dd>&nbsp;</dd>
877877
<dt><span class="memberNameLink"><a href="org/spdx/Configuration.html#getInstance()">getInstance()</a></span> - Static method in class org.spdx.<a href="org/spdx/Configuration.html" title="class in org.spdx">Configuration</a></dt>
878-
<dd>&nbsp;</dd>
878+
<dd>
879+
<div class="block">Retrieve the singleton instance of the Configuration class</div>
880+
</dd>
879881
<dt><span class="memberNameLink"><a href="org/spdx/utility/DownloadCache.html#getInstance()">getInstance()</a></span> - Static method in class org.spdx.utility.<a href="org/spdx/utility/DownloadCache.html" title="class in org.spdx.utility">DownloadCache</a></dt>
880882
<dd>&nbsp;</dd>
881883
<dt><span class="memberNameLink"><a href="org/spdx/storage/simple/InMemSpdxStore.html#getItem(java.lang.String)">getItem(String)</a></span> - Method in class org.spdx.storage.simple.<a href="org/spdx/storage/simple/InMemSpdxStore.html" title="class in org.spdx.storage.simple">InMemSpdxStore</a></dt>
@@ -1027,9 +1029,19 @@ <h2 class="title">G</h2>
10271029
<dt><span class="memberNameLink"><a href="org/spdx/utility/compare/SpdxPackageComparer.html#getPackageName()">getPackageName()</a></span> - Method in class org.spdx.utility.compare.<a href="org/spdx/utility/compare/SpdxPackageComparer.html" title="class in org.spdx.utility.compare">SpdxPackageComparer</a></dt>
10281030
<dd>&nbsp;</dd>
10291031
<dt><span class="memberNameLink"><a href="org/spdx/Configuration.html#getProperty(java.lang.String)">getProperty(String)</a></span> - Method in class org.spdx.<a href="org/spdx/Configuration.html" title="class in org.spdx">Configuration</a></dt>
1030-
<dd>&nbsp;</dd>
1032+
<dd>
1033+
<div class="block">Retrieve the value of a configuration property by its name</div>
1034+
</dd>
10311035
<dt><span class="memberNameLink"><a href="org/spdx/Configuration.html#getProperty(java.lang.String,java.lang.String)">getProperty(String, String)</a></span> - Method in class org.spdx.<a href="org/spdx/Configuration.html" title="class in org.spdx">Configuration</a></dt>
1032-
<dd>&nbsp;</dd>
1036+
<dd>
1037+
<div class="block">Retrieve the value of a configuration property by its name;
1038+
return a default value if was not found</div>
1039+
</dd>
1040+
<dt><span class="memberNameLink"><a href="org/spdx/Configuration.html#getProperty(java.util.List,java.lang.String)">getProperty(List&lt;String&gt;, String)</a></span> - Method in class org.spdx.<a href="org/spdx/Configuration.html" title="class in org.spdx">Configuration</a></dt>
1041+
<dd>
1042+
<div class="block">Retrieve the value of the first found configuration property from a list
1043+
of names; return a default value if none are found</div>
1044+
</dd>
10331045
<dt><span class="memberNameLink"><a href="org/spdx/storage/listedlicense/CrossRefJson.html#getPropertyValueDescriptors()">getPropertyValueDescriptors()</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>
10341046
<dd>
10351047
<div class="block">Retrieve all valid property descriptors for this object</div>

member-search-index.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

member-search-index.zip

10 Bytes
Binary file not shown.

org/spdx/Configuration.html

Lines changed: 49 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
catch(err) {
2828
}
2929
//-->
30-
var data = {"i0":9,"i1":10,"i2":10};
30+
var data = {"i0":9,"i1":10,"i2":10,"i3":10};
3131
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
3232
var altColor = "altColor";
3333
var rowColor = "rowColor";
@@ -170,18 +170,34 @@ <h3>Method Summary</h3>
170170
<tr id="i0" class="altColor">
171171
<td class="colFirst"><code>static <a href="Configuration.html" title="class in org.spdx">Configuration</a></code></td>
172172
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInstance()">getInstance</a></span>()</code></th>
173-
<td class="colLast">&nbsp;</td>
173+
<td class="colLast">
174+
<div class="block">Retrieve the singleton instance of the Configuration class</div>
175+
</td>
174176
</tr>
175177
<tr id="i1" class="rowColor">
176178
<td class="colFirst"><code><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>
177179
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProperty(java.lang.String)">getProperty</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;propertyName)</code></th>
178-
<td class="colLast">&nbsp;</td>
180+
<td class="colLast">
181+
<div class="block">Retrieve the value of a configuration property by its name</div>
182+
</td>
179183
</tr>
180184
<tr id="i2" class="altColor">
181185
<td class="colFirst"><code><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>
182186
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProperty(java.lang.String,java.lang.String)">getProperty</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;propertyName,
183187
<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;defaultValue)</code></th>
184-
<td class="colLast">&nbsp;</td>
188+
<td class="colLast">
189+
<div class="block">Retrieve the value of a configuration property by its name;
190+
return a default value if was not found</div>
191+
</td>
192+
</tr>
193+
<tr id="i3" class="rowColor">
194+
<td class="colFirst"><code><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>
195+
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProperty(java.util.List,java.lang.String)">getProperty</a></span>&#8203;(<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;&nbsp;propertyNames,
196+
<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;defaultValue)</code></th>
197+
<td class="colLast">
198+
<div class="block">Retrieve the value of the first found configuration property from a list
199+
of names; return a default value if none are found</div>
200+
</td>
185201
</tr>
186202
</table>
187203
<ul class="blockList">
@@ -214,6 +230,7 @@ <h3>Method Detail</h3>
214230
<li class="blockList">
215231
<h4>getInstance</h4>
216232
<pre class="methodSignature">public static&nbsp;<a href="Configuration.html" title="class in org.spdx">Configuration</a>&nbsp;getInstance()</pre>
233+
<div class="block">Retrieve the singleton instance of the Configuration class</div>
217234
<dl>
218235
<dt><span class="returnLabel">Returns:</span></dt>
219236
<dd>The singleton instance of the Configuration class.</dd>
@@ -227,6 +244,7 @@ <h4>getInstance</h4>
227244
<li class="blockList">
228245
<h4>getProperty</h4>
229246
<pre class="methodSignature">public&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;getProperty&#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;propertyName)</pre>
247+
<div class="block">Retrieve the value of a configuration property by its name</div>
230248
<dl>
231249
<dt><span class="paramLabel">Parameters:</span></dt>
232250
<dd><code>propertyName</code> - The name of the configuration property to retrieve.</dd>
@@ -238,11 +256,13 @@ <h4>getProperty</h4>
238256
<a id="getProperty(java.lang.String,java.lang.String)">
239257
<!-- -->
240258
</a>
241-
<ul class="blockListLast">
259+
<ul class="blockList">
242260
<li class="blockList">
243261
<h4>getProperty</h4>
244262
<pre class="methodSignature">public&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;getProperty&#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;propertyName,
245263
<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;defaultValue)</pre>
264+
<div class="block">Retrieve the value of a configuration property by its name;
265+
return a default value if was not found</div>
246266
<dl>
247267
<dt><span class="paramLabel">Parameters:</span></dt>
248268
<dd><code>propertyName</code> - The name of the configuration property to retrieve.</dd>
@@ -252,6 +272,30 @@ <h4>getProperty</h4>
252272
</dl>
253273
</li>
254274
</ul>
275+
<a id="getProperty(java.util.List,java.lang.String)">
276+
<!-- -->
277+
</a>
278+
<ul class="blockListLast">
279+
<li class="blockList">
280+
<h4>getProperty</h4>
281+
<pre class="methodSignature">public&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;getProperty&#8203;(<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;&nbsp;propertyNames,
282+
<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;defaultValue)</pre>
283+
<div class="block">Retrieve the value of the first found configuration property from a list
284+
of names; return a default value if none are found
285+
<p>
286+
This method checks each property name in the provided list in order.
287+
If a property name is not found, it moves on to the next one.
288+
If a property name is found, its value is returned.
289+
If none of the property names are found, the provided default value is returned.</div>
290+
<dl>
291+
<dt><span class="paramLabel">Parameters:</span></dt>
292+
<dd><code>propertyNames</code> - An ordered list of configuration property names to retrieve.</dd>
293+
<dd><code>defaultValue</code> - The default value to return if none of the properties are found.</dd>
294+
<dt><span class="returnLabel">Returns:</span></dt>
295+
<dd>The value of the first found property name, or <code>defaultValue</code> if none are found.</dd>
296+
</dl>
297+
</li>
298+
</ul>
255299
</li>
256300
</ul>
257301
</section>

org/spdx/class-use/Configuration.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,9 @@ <h3>Uses of <a href="../Configuration.html" title="class in org.spdx">Configurat
131131
<tr class="altColor">
132132
<td class="colFirst"><code>static <a href="../Configuration.html" title="class in org.spdx">Configuration</a></code></td>
133133
<th class="colSecond" scope="row"><span class="typeNameLabel">Configuration.</span><code><span class="memberNameLink"><a href="../Configuration.html#getInstance()">getInstance</a></span>()</code></th>
134-
<td class="colLast">&nbsp;</td>
134+
<td class="colLast">
135+
<div class="block">Retrieve the singleton instance of the Configuration class</div>
136+
</td>
135137
</tr>
136138
</tbody>
137139
</table>

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)