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
+16-5Lines changed: 16 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -163,7 +163,10 @@ <h2 class="title">C</h2>
163
163
<dt><spanclass="memberNameLink"><ahref="org/spdx/core/ISpdxModelInfo.html#canBeExternal(java.lang.Class)">canBeExternal(Class<?>)</a></span> - Method in interface org.spdx.core.<ahref="org/spdx/core/ISpdxModelInfo.html" title="interface in org.spdx.core">ISpdxModelInfo</a></dt>
164
164
<dd> </dd>
165
165
<dt><spanclass="memberNameLink"><ahref="org/spdx/core/ModelRegistry.html#canBeExternal(java.lang.Class,java.lang.String)">canBeExternal(Class<?>, String)</a></span> - Method in class org.spdx.core.<ahref="org/spdx/core/ModelRegistry.html" title="class in org.spdx.core">ModelRegistry</a></dt>
166
-
<dd> </dd>
166
+
<dd>
167
+
<divclass="block">Determine if the specified class can be represented as external to the model store for the
168
+
given SPDX specification version</div>
169
+
</dd>
167
170
<dt><spanclass="memberNameLink"><ahref="org/spdx/licenseTemplate/LicenseTextHelper.html#canSkip(java.lang.String)">canSkip(String)</a></span> - Static method in class org.spdx.licenseTemplate.<ahref="org/spdx/licenseTemplate/LicenseTextHelper.html" title="class in org.spdx.licenseTemplate">LicenseTextHelper</a></dt>
168
171
<dd>
169
172
<divclass="block">Returns true if the token can be ignored per the rules</div>
@@ -219,7 +222,9 @@ <h2 class="title">C</h2>
219
222
<dt><spanclass="memberNameLink"><ahref="org/spdx/core/ModelCollection.html#containsAll(java.util.Collection)">containsAll(Collection<?>)</a></span> - Method in class org.spdx.core.<ahref="org/spdx/core/ModelCollection.html" title="class in org.spdx.core">ModelCollection</a></dt>
220
223
<dd> </dd>
221
224
<dt><spanclass="memberNameLink"><ahref="org/spdx/core/ModelRegistry.html#containsSpecVersion(java.lang.String)">containsSpecVersion(String)</a></span> - Method in class org.spdx.core.<ahref="org/spdx/core/ModelRegistry.html" title="class in org.spdx.core">ModelRegistry</a></dt>
222
-
<dd> </dd>
225
+
<dd>
226
+
<divclass="block">Check if the specified SPDX specification version is supported by the registry</div>
227
+
</dd>
223
228
<dt><spanclass="memberNameLink"><ahref="org/spdx/core/IModelCopyManager.html#copy(org.spdx.storage.IModelStore,java.lang.String,org.spdx.storage.IModelStore,java.lang.String,java.lang.String,java.lang.String)">copy(IModelStore, String, IModelStore, String, String, String)</a></span> - Method in interface org.spdx.core.<ahref="org/spdx/core/IModelCopyManager.html" title="interface in org.spdx.core">IModelCopyManager</a></dt>
224
229
<dd>
225
230
<divclass="block">Copy an item from one Model Object Store to another</div>
@@ -478,7 +483,9 @@ <h2 class="title">G</h2>
478
483
<dt><spanclass="memberNameLink"><ahref="org/spdx/licenseTemplate/LicenseTemplateRule.html#getMatch()">getMatch()</a></span> - Method in class org.spdx.licenseTemplate.<ahref="org/spdx/licenseTemplate/LicenseTemplateRule.html" title="class in org.spdx.licenseTemplate">LicenseTemplateRule</a></dt>
479
484
<dd> </dd>
480
485
<dt><spanclass="memberNameLink"><ahref="org/spdx/core/ModelRegistry.html#getModelRegistry()">getModelRegistry()</a></span> - Static method in class org.spdx.core.<ahref="org/spdx/core/ModelRegistry.html" title="class in org.spdx.core">ModelRegistry</a></dt>
481
-
<dd> </dd>
486
+
<dd>
487
+
<divclass="block">Retrieve the singleton instance of the ModelRegistry</div>
488
+
</dd>
482
489
<dt><spanclass="memberNameLink"><ahref="org/spdx/core/CoreModelObject.CoreModelObjectBuilder.html#getModelStore()">getModelStore()</a></span> - Method in class org.spdx.core.<ahref="org/spdx/core/CoreModelObject.CoreModelObjectBuilder.html" title="class in org.spdx.core">CoreModelObject.CoreModelObjectBuilder</a></dt>
483
490
<dd> </dd>
484
491
<dt><spanclass="memberNameLink"><ahref="org/spdx/core/CoreModelObject.html#getModelStore()">getModelStore()</a></span> - Method in class org.spdx.core.<ahref="org/spdx/core/CoreModelObject.html" title="class in org.spdx.core">CoreModelObject</a></dt>
@@ -546,7 +553,9 @@ <h2 class="title">G</h2>
546
553
<dt><spanclass="memberNameLink"><ahref="org/spdx/core/CoreModelObject.html#getStringPropertyValue(org.spdx.storage.PropertyDescriptor)">getStringPropertyValue(PropertyDescriptor)</a></span> - Method in class org.spdx.core.<ahref="org/spdx/core/CoreModelObject.html" title="class in org.spdx.core">CoreModelObject</a></dt>
547
554
<dd> </dd>
548
555
<dt><spanclass="memberNameLink"><ahref="org/spdx/core/ModelRegistry.html#getSupportedVersions()">getSupportedVersions()</a></span> - Method in class org.spdx.core.<ahref="org/spdx/core/ModelRegistry.html" title="class in org.spdx.core">ModelRegistry</a></dt>
549
-
<dd> </dd>
556
+
<dd>
557
+
<divclass="block">Retrieve a list of all supported SPDX specification versions</div>
558
+
</dd>
550
559
<dt><spanclass="memberNameLink"><ahref="org/spdx/licenseTemplate/TextTemplateOutputHandler.html#getText()">getText()</a></span> - Method in class org.spdx.licenseTemplate.<ahref="org/spdx/licenseTemplate/TextTemplateOutputHandler.html" title="class in org.spdx.licenseTemplate">TextTemplateOutputHandler</a></dt>
551
560
<dd> </dd>
552
561
<dt><spanclass="memberNameLink"><ahref="org/spdx/licenseTemplate/LicenseTextHelper.html#getTokenAt(java.lang.String%5B%5D,int)">getTokenAt(String[], int)</a></span> - Static method in class org.spdx.licenseTemplate.<ahref="org/spdx/licenseTemplate/LicenseTextHelper.html" title="class in org.spdx.licenseTemplate">LicenseTextHelper</a></dt>
@@ -979,7 +988,9 @@ <h2 class="title">P</h2>
979
988
<h2class="title">R</h2>
980
989
<dl>
981
990
<dt><spanclass="memberNameLink"><ahref="org/spdx/core/ModelRegistry.html#registerModel(org.spdx.core.ISpdxModelInfo)">registerModel(ISpdxModelInfo)</a></span> - Method in class org.spdx.core.<ahref="org/spdx/core/ModelRegistry.html" title="class in org.spdx.core">ModelRegistry</a></dt>
982
-
<dd> </dd>
991
+
<dd>
992
+
<divclass="block">Register a model in the registry</div>
993
+
</dd>
983
994
<dt><spanclass="memberNameLink"><ahref="org/spdx/core/ModelCollection.html#remove(java.lang.Object)">remove(Object)</a></span> - Method in class org.spdx.core.<ahref="org/spdx/core/ModelCollection.html" title="class in org.spdx.core">ModelCollection</a></dt>
984
995
<dd> </dd>
985
996
<dt><spanclass="memberNameLink"><ahref="org/spdx/core/ModelCollection.html#removeAll(java.util.Collection)">removeAll(Collection<?>)</a></span> - Method in class org.spdx.core.<ahref="org/spdx/core/ModelCollection.html" title="class in org.spdx.core">ModelCollection</a></dt>
Copy file name to clipboardExpand all lines: org/spdx/core/ModelRegistry.html
+37-13Lines changed: 37 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -166,7 +166,10 @@ <h3>Method Summary</h3>
166
166
<tdclass="colFirst"><code>boolean</code></td>
167
167
<thclass="colSecond" scope="row"><code><spanclass="memberNameLink"><ahref="#canBeExternal(java.lang.Class,java.lang.String)">canBeExternal</a></span>​(<ahref="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> clazz,
168
168
<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> specVersion)</code></th>
169
-
<tdclass="colLast"> </td>
169
+
<tdclass="colLast">
170
+
<divclass="block">Determine if the specified class can be represented as external to the model store for the
171
+
given SPDX specification version</div>
172
+
</td>
170
173
</tr>
171
174
<trid="i1" class="rowColor">
172
175
<tdclass="colFirst"><code>void</code></td>
@@ -178,7 +181,9 @@ <h3>Method Summary</h3>
178
181
<trid="i2" class="altColor">
179
182
<tdclass="colFirst"><code>boolean</code></td>
180
183
<thclass="colSecond" scope="row"><code><spanclass="memberNameLink"><ahref="#containsSpecVersion(java.lang.String)">containsSpecVersion</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> specVersion)</code></th>
181
-
<tdclass="colLast"> </td>
184
+
<tdclass="colLast">
185
+
<divclass="block">Check if the specified SPDX specification version is supported by the registry</div>
186
+
</td>
182
187
</tr>
183
188
<trid="i3" class="rowColor">
184
189
<tdclass="colFirst"><code><ahref="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td>
@@ -192,12 +197,16 @@ <h3>Method Summary</h3>
192
197
<trid="i4" class="altColor">
193
198
<tdclass="colFirst"><code>static <ahref="ModelRegistry.html" title="class in org.spdx.core">ModelRegistry</a></code></td>
<divclass="block">Retrieve the singleton instance of the ModelRegistry</div>
202
+
</td>
196
203
</tr>
197
204
<trid="i5" class="rowColor">
198
205
<tdclass="colFirst"><code><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>></code></td>
<divclass="block">Retrieve a list of all supported SPDX specification versions</div>
209
+
</td>
201
210
</tr>
202
211
<trid="i6" class="altColor">
203
212
<tdclass="colFirst"><code><ahref="CoreModelObject.html" title="class in org.spdx.core">CoreModelObject</a></code></td>
@@ -215,7 +224,9 @@ <h3>Method Summary</h3>
215
224
<trid="i7" class="rowColor">
216
225
<tdclass="colFirst"><code>void</code></td>
217
226
<thclass="colSecond" scope="row"><code><spanclass="memberNameLink"><ahref="#registerModel(org.spdx.core.ISpdxModelInfo)">registerModel</a></span>​(<ahref="ISpdxModelInfo.html" title="interface in org.spdx.core">ISpdxModelInfo</a> modelInfo)</code></th>
218
-
<tdclass="colLast"> </td>
227
+
<tdclass="colLast">
228
+
<divclass="block">Register a model in the registry</div>
229
+
</td>
219
230
</tr>
220
231
<trid="i8" class="altColor">
221
232
<tdclass="colFirst"><code><ahref="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?></code></td>
@@ -269,6 +280,11 @@ <h3>Method Detail</h3>
269
280
<liclass="blockList">
270
281
<h4>getModelRegistry</h4>
271
282
<preclass="methodSignature">public static <ahref="ModelRegistry.html" title="class in org.spdx.core">ModelRegistry</a> getModelRegistry()</pre>
283
+
<divclass="block">Retrieve the singleton instance of the ModelRegistry</div>
<preclass="methodSignature">public void registerModel​(<ahref="ISpdxModelInfo.html" title="interface in org.spdx.core">ISpdxModelInfo</a> modelInfo)</pre>
297
+
<divclass="block">Register a model in the registry
298
+
<p>
299
+
Each specification version supported by the model will be added to the registry.</div>
<dd><code>modelInfo</code> - model info to register</dd>
302
+
<dd><code>modelInfo</code> - The model information to register</dd>
284
303
</dl>
285
304
</li>
286
305
</ul>
@@ -291,11 +310,12 @@ <h4>registerModel</h4>
291
310
<liclass="blockList">
292
311
<h4>containsSpecVersion</h4>
293
312
<preclass="methodSignature">public boolean containsSpecVersion​(<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> specVersion)</pre>
313
+
<divclass="block">Check if the specified SPDX specification version is supported by the registry</div>
<dd><code>specVersion</code> - version of the spc</dd>
316
+
<dd><code>specVersion</code> - The version of the SPDX specification to check.</dd>
297
317
<dt><spanclass="returnLabel">Returns:</span></dt>
298
-
<dd>true if the specVersion is supported in one of the registered model infos</dd>
318
+
<dd><code>true</code> if the specified specVersion is supported, <code>false</code> otherwise.</dd>
299
319
</dl>
300
320
</li>
301
321
</ul>
@@ -442,9 +462,10 @@ <h4>clearAll</h4>
442
462
<liclass="blockList">
443
463
<h4>getSupportedVersions</h4>
444
464
<preclass="methodSignature">public <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>> getSupportedVersions()</pre>
465
+
<divclass="block">Retrieve a list of all supported SPDX specification versions</div>
445
466
<dl>
446
467
<dt><spanclass="returnLabel">Returns:</span></dt>
447
-
<dd>a list of all supported versions</dd>
468
+
<dd>An unmodifiable list of all supported specification versions.</dd>
448
469
</dl>
449
470
</li>
450
471
</ul>
@@ -457,14 +478,17 @@ <h4>canBeExternal</h4>
457
478
<preclass="methodSignature">public boolean canBeExternal​(<ahref="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> clazz,
458
479
<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> specVersion)
459
480
throws <ahref="ModelRegistryException.html" title="class in org.spdx.core">ModelRegistryException</a></pre>
481
+
<divclass="block">Determine if the specified class can be represented as external to the model store for the
<dd><code>specVersion</code> - version of the spec</dd>
485
+
<dd><code>clazz</code> - The model class to check.</dd>
486
+
<dd><code>specVersion</code> - The version of the SPDX specification.</dd>
464
487
<dt><spanclass="returnLabel">Returns:</span></dt>
465
-
<dd>true if clazz can be represented as external to the store</dd>
488
+
<dd><code>true</code> if the class can be represented as external to the store, <code>false</code>
489
+
otherwise.</dd>
466
490
<dt><spanclass="throwsLabel">Throws:</span></dt>
467
-
<dd><code><ahref="ModelRegistryException.html" title="class in org.spdx.core">ModelRegistryException</a></code> - on uninitialized registry</dd>
491
+
<dd><code><ahref="ModelRegistryException.html" title="class in org.spdx.core">ModelRegistryException</a></code> - If the registry does not support the specified specVersion.</dd>
Copy file name to clipboardExpand all lines: org/spdx/core/class-use/ISpdxModelInfo.html
+3-1Lines changed: 3 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -133,7 +133,9 @@ <h3>Uses of <a href="../ISpdxModelInfo.html" title="interface in org.spdx.core">
133
133
<trclass="altColor">
134
134
<tdclass="colFirst"><code>void</code></td>
135
135
<thclass="colSecond" scope="row"><spanclass="typeNameLabel">ModelRegistry.</span><code><spanclass="memberNameLink"><ahref="../ModelRegistry.html#registerModel(org.spdx.core.ISpdxModelInfo)">registerModel</a></span>​(<ahref="../ISpdxModelInfo.html" title="interface in org.spdx.core">ISpdxModelInfo</a> modelInfo)</code></th>
136
-
<tdclass="colLast"> </td>
136
+
<tdclass="colLast">
137
+
<divclass="block">Register a model in the registry</div>
Copy file name to clipboardExpand all lines: org/spdx/core/class-use/ModelRegistryException.html
+4-1Lines changed: 4 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -134,7 +134,10 @@ <h3>Uses of <a href="../ModelRegistryException.html" title="class in org.spdx.co
134
134
<tdclass="colFirst"><code>boolean</code></td>
135
135
<thclass="colSecond" scope="row"><spanclass="typeNameLabel">ModelRegistry.</span><code><spanclass="memberNameLink"><ahref="../ModelRegistry.html#canBeExternal(java.lang.Class,java.lang.String)">canBeExternal</a></span>​(<ahref="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> clazz,
136
136
<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> specVersion)</code></th>
137
-
<tdclass="colLast"> </td>
137
+
<tdclass="colLast">
138
+
<divclass="block">Determine if the specified class can be represented as external to the model store for the
139
+
given SPDX specification version</div>
140
+
</td>
138
141
</tr>
139
142
<trclass="rowColor">
140
143
<tdclass="colFirst"><code><ahref="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?></code></td>
0 commit comments