cyclonedx.exception.model
=========================

.. py:module:: cyclonedx.exception.model

.. autoapi-nested-parse::

   Exceptions relating to specific conditions that occur when modelling CycloneDX BOM.



Classes
-------

.. autoapisummary::

   cyclonedx.exception.model.CycloneDxModelException
   cyclonedx.exception.model.InvalidValueException
   cyclonedx.exception.model.InvalidLocaleTypeException
   cyclonedx.exception.model.InvalidNistQuantumSecurityLevelException
   cyclonedx.exception.model.InvalidOmniBorIdException
   cyclonedx.exception.model.InvalidRelatedCryptoMaterialSizeException
   cyclonedx.exception.model.InvalidSwhidException
   cyclonedx.exception.model.InvalidUriException
   cyclonedx.exception.model.MutuallyExclusivePropertiesException
   cyclonedx.exception.model.NoPropertiesProvidedException
   cyclonedx.exception.model.UnknownComponentDependencyException
   cyclonedx.exception.model.UnknownHashTypeException
   cyclonedx.exception.model.LicenseExpressionAlongWithOthersException
   cyclonedx.exception.model.InvalidCreIdException
   cyclonedx.exception.model.InvalidConfidenceException


Module Contents
---------------

.. py:class:: CycloneDxModelException

   Bases: :py:obj:`cyclonedx.exception.CycloneDxException`


   Base exception that covers all exceptions that may be thrown during model creation.


.. py:class:: InvalidValueException

   Bases: :py:obj:`CycloneDxModelException`


   Base exception that covers all exceptions that may be thrown during model creation.


.. py:class:: InvalidLocaleTypeException

   Bases: :py:obj:`CycloneDxModelException`


   Raised when the supplied locale does not conform to ISO-639 specification.

   Good examples:
       - en
       - en-US
       - en-GB
       - fr
       - fr-CA

   The language code MUST be lowercase. If the country code is specified, the country code MUST be upper case.
   The language code and country code MUST be separated by a minus sign.


.. py:class:: InvalidNistQuantumSecurityLevelException

   Bases: :py:obj:`CycloneDxModelException`


   Raised when an invalid value is provided for an NIST Quantum Security Level
   as defined at https://csrc.nist.gov/projects/post-quantum-cryptography/post-quantum-cryptography-standardization/
   evaluation-criteria/security-(evaluation-criteria).


.. py:class:: InvalidOmniBorIdException

   Bases: :py:obj:`CycloneDxModelException`


   Raised when a supplied value for an OmniBOR ID does not meet the format requirements
   as defined at https://www.iana.org/assignments/uri-schemes/prov/gitoid.


.. py:class:: InvalidRelatedCryptoMaterialSizeException

   Bases: :py:obj:`CycloneDxModelException`


   Raised when the supplied size of a Related Crypto Material is negative.


.. py:class:: InvalidSwhidException

   Bases: :py:obj:`CycloneDxModelException`


   Raised when a supplied value for an Swhid does not meet the format requirements
   as defined at https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html.


.. py:class:: InvalidUriException

   Bases: :py:obj:`CycloneDxModelException`


   Raised when a `str` is provided that needs to be a valid URI, but isn't.


.. py:class:: MutuallyExclusivePropertiesException

   Bases: :py:obj:`CycloneDxModelException`


   Raised when mutually exclusive properties are provided.


.. py:class:: NoPropertiesProvidedException

   Bases: :py:obj:`CycloneDxModelException`


   Raised when attempting to construct a model class and providing NO values (where all properites are defined as
   Optional, but at least one is required).


.. py:class:: UnknownComponentDependencyException

   Bases: :py:obj:`CycloneDxModelException`


   Exception raised when a dependency has been noted for a Component that is NOT a Component BomRef in this Bom.


.. py:class:: UnknownHashTypeException

   Bases: :py:obj:`CycloneDxModelException`


   Exception raised when we are unable to determine the type of hash from a composite hash string.


.. py:class:: LicenseExpressionAlongWithOthersException

   Bases: :py:obj:`CycloneDxModelException`


   Exception raised when a LicenseExpression was detected along with other licenses.
   If a LicenseExpression exists, than it must stand alone.

   See https://github.com/CycloneDX/specification/pull/205


.. py:class:: InvalidCreIdException

   Bases: :py:obj:`CycloneDxModelException`


   Raised when a supplied value for an CRE ID does not meet the format requirements
   as defined at https://opencre.org/


.. py:class:: InvalidConfidenceException

   Bases: :py:obj:`CycloneDxModelException`


   Raised when an invalid value is provided for a Confidence.
   The confidence of the evidence from 0 - 1, where 1 is 100% confidence.