You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: index-all.html
+15-3Lines changed: 15 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -875,7 +875,9 @@ <h2 class="title">G</h2>
875
875
<dt><spanclass="memberNameLink"><ahref="org/spdx/storage/simple/InMemSpdxStore.html#getIdType(java.lang.String)">getIdType(String)</a></span> - Method in class org.spdx.storage.simple.<ahref="org/spdx/storage/simple/InMemSpdxStore.html" title="class in org.spdx.storage.simple">InMemSpdxStore</a></dt>
876
876
<dd> </dd>
877
877
<dt><spanclass="memberNameLink"><ahref="org/spdx/Configuration.html#getInstance()">getInstance()</a></span> - Static method in class org.spdx.<ahref="org/spdx/Configuration.html" title="class in org.spdx">Configuration</a></dt>
878
-
<dd> </dd>
878
+
<dd>
879
+
<divclass="block">Retrieve the singleton instance of the Configuration class</div>
880
+
</dd>
879
881
<dt><spanclass="memberNameLink"><ahref="org/spdx/utility/DownloadCache.html#getInstance()">getInstance()</a></span> - Static method in class org.spdx.utility.<ahref="org/spdx/utility/DownloadCache.html" title="class in org.spdx.utility">DownloadCache</a></dt>
880
882
<dd> </dd>
881
883
<dt><spanclass="memberNameLink"><ahref="org/spdx/storage/simple/InMemSpdxStore.html#getItem(java.lang.String)">getItem(String)</a></span> - Method in class org.spdx.storage.simple.<ahref="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>
1027
1029
<dt><spanclass="memberNameLink"><ahref="org/spdx/utility/compare/SpdxPackageComparer.html#getPackageName()">getPackageName()</a></span> - Method in class org.spdx.utility.compare.<ahref="org/spdx/utility/compare/SpdxPackageComparer.html" title="class in org.spdx.utility.compare">SpdxPackageComparer</a></dt>
1028
1030
<dd> </dd>
1029
1031
<dt><spanclass="memberNameLink"><ahref="org/spdx/Configuration.html#getProperty(java.lang.String)">getProperty(String)</a></span> - Method in class org.spdx.<ahref="org/spdx/Configuration.html" title="class in org.spdx">Configuration</a></dt>
1030
-
<dd> </dd>
1032
+
<dd>
1033
+
<divclass="block">Retrieve the value of a configuration property by its name</div>
1034
+
</dd>
1031
1035
<dt><spanclass="memberNameLink"><ahref="org/spdx/Configuration.html#getProperty(java.lang.String,java.lang.String)">getProperty(String, String)</a></span> - Method in class org.spdx.<ahref="org/spdx/Configuration.html" title="class in org.spdx">Configuration</a></dt>
1032
-
<dd> </dd>
1036
+
<dd>
1037
+
<divclass="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><spanclass="memberNameLink"><ahref="org/spdx/Configuration.html#getProperty(java.util.List,java.lang.String)">getProperty(List<String>, String)</a></span> - Method in class org.spdx.<ahref="org/spdx/Configuration.html" title="class in org.spdx">Configuration</a></dt>
1041
+
<dd>
1042
+
<divclass="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>
1033
1045
<dt><spanclass="memberNameLink"><ahref="org/spdx/storage/listedlicense/CrossRefJson.html#getPropertyValueDescriptors()">getPropertyValueDescriptors()</a></span> - Method in class org.spdx.storage.listedlicense.<ahref="org/spdx/storage/listedlicense/CrossRefJson.html" title="class in org.spdx.storage.listedlicense">CrossRefJson</a></dt>
1034
1046
<dd>
1035
1047
<divclass="block">Retrieve all valid property descriptors for this object</div>
<divclass="block">Retrieve the singleton instance of the Configuration class</div>
175
+
</td>
174
176
</tr>
175
177
<trid="i1" class="rowColor">
176
178
<tdclass="colFirst"><code><ahref="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>
177
179
<thclass="colSecond" scope="row"><code><spanclass="memberNameLink"><ahref="#getProperty(java.lang.String)">getProperty</a></span>​(<ahref="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> propertyName)</code></th>
178
-
<tdclass="colLast"> </td>
180
+
<tdclass="colLast">
181
+
<divclass="block">Retrieve the value of a configuration property by its name</div>
182
+
</td>
179
183
</tr>
180
184
<trid="i2" class="altColor">
181
185
<tdclass="colFirst"><code><ahref="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>
182
186
<thclass="colSecond" scope="row"><code><spanclass="memberNameLink"><ahref="#getProperty(java.lang.String,java.lang.String)">getProperty</a></span>​(<ahref="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> propertyName,
183
187
<ahref="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> defaultValue)</code></th>
184
-
<tdclass="colLast"> </td>
188
+
<tdclass="colLast">
189
+
<divclass="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
+
<trid="i3" class="rowColor">
194
+
<tdclass="colFirst"><code><ahref="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
+
<thclass="colSecond" scope="row"><code><spanclass="memberNameLink"><ahref="#getProperty(java.util.List,java.lang.String)">getProperty</a></span>​(<ahref="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><<ahref="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>> propertyNames,
196
+
<ahref="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> defaultValue)</code></th>
197
+
<tdclass="colLast">
198
+
<divclass="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>
185
201
</tr>
186
202
</table>
187
203
<ulclass="blockList">
@@ -214,6 +230,7 @@ <h3>Method Detail</h3>
214
230
<liclass="blockList">
215
231
<h4>getInstance</h4>
216
232
<preclass="methodSignature">public static <ahref="Configuration.html" title="class in org.spdx">Configuration</a> getInstance()</pre>
233
+
<divclass="block">Retrieve the singleton instance of the Configuration class</div>
217
234
<dl>
218
235
<dt><spanclass="returnLabel">Returns:</span></dt>
219
236
<dd>The singleton instance of the Configuration class.</dd>
@@ -227,6 +244,7 @@ <h4>getInstance</h4>
227
244
<liclass="blockList">
228
245
<h4>getProperty</h4>
229
246
<preclass="methodSignature">public <ahref="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> getProperty​(<ahref="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> propertyName)</pre>
247
+
<divclass="block">Retrieve the value of a configuration property by its name</div>
<preclass="methodSignature">public <ahref="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> getProperty​(<ahref="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> propertyName,
245
263
<ahref="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> defaultValue)</pre>
264
+
<divclass="block">Retrieve the value of a configuration property by its name;
<preclass="methodSignature">public <ahref="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> getProperty​(<ahref="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><<ahref="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>> propertyNames,
282
+
<ahref="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> defaultValue)</pre>
283
+
<divclass="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>
0 commit comments