spdx.exceptions — com.github.pmonks/clj-spdx 1.0.286

Exception list functionality, primarily provided by org.spdx.library.ListedLicenses.

addition-ref clj

(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.

addition-ref-map->string clj

(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.

addition-ref? clj

(addition-ref? s)

Is s (a String) a valid AdditionRef? See SPDX Annex B for specifics.

canonicalise-id clj

(canonicalise-id id)

Canonicalises id (an SPDX exception identifier), by returning it in its canonical case. Returns nil if id is nil or not a listed SPDX exception identifier.

Notes:

• This function does not canonicalise a deprecated id to its non-deprecated equivalent, since some of those conversions result in an SPDX expression rather than an individual id. spdx.expressions/parse can be used for that.

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.

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 false if s1 or s2 are not valid AdditionRefs

equivalent-ids? clj

(equivalent-ids? id1 id2)

Are id1 and id2 (Strings) equivalent SPDX exception identifiers (i.e. taking the SPDX case sensitivity rules in SPDX Annex B into account)?

Notes:

• Returns false if id1 or id2 are not valid SPDX license exception identifiers

equivalent? clj

(equivalent? s1 s2)

Are s1 and s2 (Strings) equivalent SPDX license exception identifiers or AdditionRefs (i.e. taking the SPDX case sensitivity rules in SPDX Annex B into account)?

Notes:

• Returns false if s1 or s2 are not listed SPDX license exception identifiers or valid AdditionRefs

id->info clj

(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 identifier.

opts are:

• :include-large-text-values? (default false) - controls whether large text values are included in the result or not

ids clj

(ids)

The set of all exception ids.

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 function may have a substantial performance cost.

listed-id? clj

(listed-id? id)

Is id (a String) one of the listed SPDX exception identifiers?

Notes:

• This fn supports any case of identifier, as per the SPDX case sensitivity rules in SPDX Annex B

non-deprecated-ids clj

(non-deprecated-ids)

(non-deprecated-ids ids)

Returns the set of SPDX exception identifiers that identify current (non-deprecated) exceptions within the provided set of SPDX exception identifiers (or all of them, if ids not provided).

string->addition-ref-map clj

(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 clj

(version)

The version of the exception list (a String in major.minor(.patchlevel) format).

Note: identical to spdx.licenses/version.