From ce1285a53dd8888f28d93e5b60f98fb2961ad880 Mon Sep 17 00:00:00 2001 From: sabashaikh4 Date: Tue, 10 Feb 2026 20:05:26 +0530 Subject: [PATCH] docs: clarify LicenseChoice class name and purpose Signed-off-by: sabashaikh4 --- .../java/org/cyclonedx/model/LicenseChoice.java | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/main/java/org/cyclonedx/model/LicenseChoice.java b/src/main/java/org/cyclonedx/model/LicenseChoice.java index c3618d095f..23e26112bd 100644 --- a/src/main/java/org/cyclonedx/model/LicenseChoice.java +++ b/src/main/java/org/cyclonedx/model/LicenseChoice.java @@ -28,6 +28,21 @@ import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty; import org.cyclonedx.model.license.Expression; import org.cyclonedx.util.deserializer.LicenseDeserializer; +/** + * Represents the CycloneDX specification structure for expressing license information. + * + *

License information can be provided in exactly one of the following mutually exclusive forms:

+ * + * + *

This class does not implement any logic to interpret or resolve license expressions + * (e.g., selecting MIT from "MIT OR BSD"). It serves as a container for license data + * in one of the supported formats.

+ * + *

Note: Setting one representation automatically clears the other.

+ */ @JsonIgnoreProperties(ignoreUnknown = true) @JsonInclude(JsonInclude.Include.NON_EMPTY)