spdx.exceptions
Exception list functionality, primarily provided by org.spdx.library.model.license.ListedLicenses
.
addition-ref
(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’ String
s. Returns nil
if addition-ref
is blank, or the resulting value is not a valid AdditionRef.
addition-ref-map->string
(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.
canonicalise-id
(canonicalise-id id)
Canonicalises id
(an SPDX license exception identifier), by returning it in its canonical case. Returns nil
if id
is nil
or not a listed SPDX license exception identifier.
deprecated-id?
(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.
equivalent-addition-refs?
(equivalent-addition-refs? s1 s2)
Are s1
and s2
(String
s) equivalent AdditionRefs (i.e. taking the SPDX case sensitivity rules in SPDX Annex B into account)?
Notes:
- Returns
false
ifs1
ors2
are not valid AdditionRefs
equivalent-ids?
(equivalent-ids? id1 id2)
Are id1
and id2
(String
s) equivalent SPDX license exception identifiers (i.e. taking the SPDX case sensitivity rules in SPDX Annex B into account)?
Notes:
- Returns
false
ifid1
orid2
are not valid SPDX license exception identifiers
equivalent?
(equivalent? s1 s2)
Are s1
and s2
(String
s) equivalent SPDX license exception identifiers or AdditionRefs (i.e. taking the SPDX case sensitivity rules in SPDX Annex B into account)?
Notes:
- Returns
false
ifs1
ors2
are not listed SPDX license exception identifiers or valid AdditionRefs
id->info
(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
init!
(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.
non-deprecated-ids
(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 license exception ids (or all of them, if ids
not provided).
string->addition-ref-map
(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.
version
(version)
The version of the exception list (a String
in major.minor format).
Note: identical to spdx.licenses/version.