cyclonedx.model.bom_ref
=======================

.. py:module:: cyclonedx.model.bom_ref


Classes
-------

.. autoapisummary::

   cyclonedx.model.bom_ref.BomRef


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

.. py:class:: BomRef(value: Optional[str] = None)

   Bases: :py:obj:`py_serializable.helpers.BaseHelper`


   An identifier that can be used to reference objects elsewhere in the BOM.

   This copies a similar pattern used in the CycloneDX PHP Library.

   .. note::
       See https://github.com/CycloneDX/cyclonedx-php-library/blob/master/docs/dev/decisions/BomDependencyDataModel.md


   .. py:property:: value
      :type: Optional[str]



   .. py:method:: serialize(o: Any) -> Optional[str]
      :classmethod:


      general purpose serializer



   .. py:method:: deserialize(o: Any) -> _T_BR
      :classmethod:


      general purpose deserializer



   .. py:method:: json_normalize(o: Any, *, view: Optional[Type[py_serializable.ViewType]], prop_info: py_serializable.ObjectMetadataLibrary.SerializableProperty, ctx: Type[Any], **kwargs: Any) -> Optional[Any]
      :classmethod:


      json specific normalizer



   .. py:method:: json_serialize(o: Any) -> Union[str, Any]
      :classmethod:


      json specific serializer



   .. py:method:: json_denormalize(o: Any, *, prop_info: py_serializable.ObjectMetadataLibrary.SerializableProperty, ctx: Type[Any], **kwargs: Any) -> Any
      :classmethod:


      json specific denormalizer

      :param tCls: the class that was desired to denormalize to
      :param pCls: tha prent class - as context



   .. py:method:: json_deserialize(o: Any) -> Any
      :classmethod:


      json specific deserializer



   .. py:method:: xml_normalize(o: Any, *, element_name: str, view: Optional[Type[py_serializable.ViewType]], xmlns: Optional[str], prop_info: py_serializable.ObjectMetadataLibrary.SerializableProperty, ctx: Type[Any], **kwargs: Any) -> Optional[Union[xml.etree.ElementTree.Element, Any]]
      :classmethod:


      xml specific normalizer



   .. py:method:: xml_serialize(o: Any) -> Union[str, Any]
      :classmethod:


      xml specific serializer



   .. py:method:: xml_denormalize(o: xml.etree.ElementTree.Element, *, default_ns: Optional[str], prop_info: py_serializable.ObjectMetadataLibrary.SerializableProperty, ctx: Type[Any], **kwargs: Any) -> Any
      :classmethod:


      xml specific denormalizer



   .. py:method:: xml_deserialize(o: Union[str, Any]) -> Any
      :classmethod:


      xml specific deserializer



