spdx.exceptions
Exception list functionality, primarily provided by org.spdx.library.model.license.ListedLicenses.
Exception list functionality, primarily provided by `org.spdx.library.model.license.ListedLicenses`.
addition-refclj
(addition-ref addition-ref-var-section)(addition-ref document-ref-var-section addition-ref-var-section)Constructs an AdditionRef (as a String) from individual 'variable
section' Strings. Returns nil if addition-ref is blank, or the resulting
value is not a valid AdditionRef.
Constructs an AdditionRef (as a `String`) from individual 'variable section' `String`s. Returns `nil` if `addition-ref` is blank, or the resulting value is not a valid AdditionRef.
addition-ref-map->stringclj
(addition-ref-map->string m)Turns map m representing an AdditionRef into a String, returning nil if
m is nil or the resulting value is not a valid AdditionRef.
Note:
- This fn is the inverse of
string->addition-ref-map.
Turns map `m` representing an AdditionRef into a `String`, returning `nil` if `m` is `nil` or the resulting value is not a valid AdditionRef. Note: * This fn is the inverse of [[string->addition-ref-map]].
addition-ref?clj
(addition-ref? s)Is s (a String) a valid AdditionRef? See
SPDX Annex B
for specifics.
Is `s` (a `String`) a valid `AdditionRef`? See [SPDX Annex B](https://spdx.github.io/spdx-spec/v3.0.1/annexes/spdx-license-expressions/) for specifics.
deprecated-id?clj
(deprecated-id? id)Is id (a String) deprecated? Also returns false if id is not in the
SPDX license exception list.
See this SPDX FAQ item for details on what this means.
Is `id` (a `String`) deprecated? Also returns `false` if `id` is not in the SPDX license exception list. See [this SPDX FAQ item](https://github.com/spdx/license-list-XML/blob/main/DOCS/faq.md#what-does-it-mean-when-a-license-id-is-deprecated) for details on what this means.
equivalent-addition-refs?clj
(equivalent-addition-refs? s1 s2)Are s1 and s2 (Strings) equivalent AdditionRefs (i.e. taking the SPDX
case sensitivity rules in SPDX Annex B
into account)?
Notes:
- Returns
falseifs1ors2are not valid AdditionRefs
Are `s1` and `s2` (`String`s) equivalent AdditionRefs (i.e. taking the SPDX case sensitivity rules in [SPDX Annex B](https://spdx.github.io/spdx-spec/v3.0.1/annexes/spdx-license-expressions/#case-sensitivity) into account)? Notes: * Returns `false` if `s1` or `s2` are not valid AdditionRefs
id->infoclj
(id->info id)(id->info id
{:keys [include-large-text-values?]
:or {include-large-text-values? false}
:as opts})Returns SPDX exception list information for id (a String) as a map, or
nil if id is not a valid SPDX exception id.
opts are:
:include-large-text-values?(defaultfalse) - controls whether the following large text values are included in the result::comment :text :text-html :text-template
Returns SPDX exception list information for `id` (a `String`) as a map, or `nil` if `id` is not a valid SPDX exception id. `opts` are: * `:include-large-text-values?` (default `false`) - controls whether the following large text values are included in the result: `:comment :text :text-html :text-template`
init!clj
(init!)Initialises this namespace upon first call (and does nothing on subsequent
calls), returning nil. Consumers of this namespace are not required to call
this fn, as initialisation will occur implicitly anyway; it is provided to
allow explicit control of the cost of initialisation to callers who need it.
Note: this method may have a substantial performance cost.
Initialises this namespace upon first call (and does nothing on subsequent calls), returning `nil`. Consumers of this namespace are not required to call this fn, as initialisation will occur implicitly anyway; it is provided to allow explicit control of the cost of initialisation to callers who need it. Note: this method may have a substantial performance cost.
listed-id?clj
(listed-id? id)Is id (a String) one of the listed SPDX exception ids?
Is `id` (a `String`) one of the listed SPDX exception ids?
non-deprecated-idsclj
(non-deprecated-ids)(non-deprecated-ids ids)Returns the set of exception ids that identify current (non-deprecated)
exceptions within the provided set of SPDX exception ids (or all of them, if
ids not provided).
Returns the set of exception ids that identify current (non-deprecated) exceptions within the provided set of SPDX exception ids (or all of them, if `ids` not provided).
string->addition-ref-mapclj
(string->addition-ref-map s)Turns s (a String containing an AdditionRef) into a map representing
that same AdditionRef. Returns nil if s is nil or not a valid
AdditionRef.
Note:
- This fn is the inverse of
addition-ref-map->string.
Turns `s` (a `String` containing an AdditionRef) into a `map` representing that same AdditionRef. Returns `nil` if `s` is `nil` or not a valid AdditionRef. Note: * This fn is the inverse of [[addition-ref-map->string]].
versionclj
(version)The version of the exception list (a String in major.minor format).
Note: identical to spdx.licenses/version.
The version of the exception list (a `String` in major.minor format). Note: identical to [[spdx.licenses/version]].
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close