# cyclonedx.model.bom_ref

## Classes

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

## Module Contents

class cyclonedx.model.bom_ref.BomRef(value: str | None = None)

  Bases: `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

  property value: str | None
  classmethod serialize(o: Any) → str | None

    general purpose serializer

  classmethod deserialize(o: Any) → _T_BR

    general purpose deserializer

  classmethod json_normalize(o: Any, *, view: Type[py_serializable.ViewType] | None, prop_info: py_serializable.ObjectMetadataLibrary.SerializableProperty, ctx: Type[Any], **kwargs: Any) → Any | None

    json specific normalizer

  classmethod json_serialize(o: Any) → str | Any

    json specific serializer

  classmethod json_denormalize(o: Any, *, prop_info: py_serializable.ObjectMetadataLibrary.SerializableProperty, ctx: Type[Any], **kwargs: Any) → Any

    json specific denormalizer

    Parameters:

      - tCls – the class that was desired to denormalize to

      - pCls – tha prent class - as context

  classmethod json_deserialize(o: Any) → Any

    json specific deserializer

  classmethod xml_normalize(o: Any, *, element_name: str, view: Type[py_serializable.ViewType] | None, xmlns: str | None, prop_info: py_serializable.ObjectMetadataLibrary.SerializableProperty, ctx: Type[Any], **kwargs: Any) → xml.etree.ElementTree.Element | Any | None

    xml specific normalizer

  classmethod xml_serialize(o: Any) → str | Any

    xml specific serializer

  classmethod xml_denormalize(o: xml.etree.ElementTree.Element, *, default_ns: str | None, prop_info: py_serializable.ObjectMetadataLibrary.SerializableProperty, ctx: Type[Any], **kwargs: Any) → Any

    xml specific denormalizer

  classmethod xml_deserialize(o: str | Any) → Any

    xml specific deserializer