cyclonedx.output.json
=====================

.. py:module:: cyclonedx.output.json


Attributes
----------

.. autoapisummary::

   cyclonedx.output.json.BY_SCHEMA_VERSION


Classes
-------

.. autoapisummary::

   cyclonedx.output.json.Json
   cyclonedx.output.json.JsonV1Dot0
   cyclonedx.output.json.JsonV1Dot1
   cyclonedx.output.json.JsonV1Dot2
   cyclonedx.output.json.JsonV1Dot3
   cyclonedx.output.json.JsonV1Dot4
   cyclonedx.output.json.JsonV1Dot5
   cyclonedx.output.json.JsonV1Dot6
   cyclonedx.output.json.JsonV1Dot7


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

.. py:class:: Json(bom: cyclonedx.model.bom.Bom)

   Bases: :py:obj:`cyclonedx.output.BaseOutput`, :py:obj:`cyclonedx.schema.schema.BaseSchemaVersion`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:property:: schema_version
      :type: cyclonedx.schema.SchemaVersion



   .. py:property:: output_format
      :type: Literal[cyclonedx.schema.OutputFormat.JSON]



   .. py:method:: generate(force_regeneration: bool = False) -> None


   .. py:method:: output_as_string(*, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> str


   .. py:property:: generated
      :type: bool



   .. py:method:: get_bom() -> cyclonedx.model.bom.Bom


   .. py:method:: set_bom(bom: cyclonedx.model.bom.Bom) -> None


   .. py:method:: output_to_file(filename: str, allow_overwrite: bool = False, *, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> None


   .. py:property:: schema_version_enum
      :type: cyclonedx.schema.SchemaVersion

      :abstractmethod:



   .. py:method:: get_schema_version() -> str


.. py:class:: JsonV1Dot0(bom: cyclonedx.model.bom.Bom)

   Bases: :py:obj:`Json`, :py:obj:`cyclonedx.schema.schema.SchemaVersion1Dot0`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:property:: schema_version
      :type: cyclonedx.schema.SchemaVersion



   .. py:property:: output_format
      :type: Literal[cyclonedx.schema.OutputFormat.JSON]



   .. py:method:: generate(force_regeneration: bool = False) -> None


   .. py:method:: output_as_string(*, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> str


   .. py:property:: generated
      :type: bool



   .. py:method:: get_bom() -> cyclonedx.model.bom.Bom


   .. py:method:: set_bom(bom: cyclonedx.model.bom.Bom) -> None


   .. py:method:: output_to_file(filename: str, allow_overwrite: bool = False, *, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> None


   .. py:property:: schema_version_enum
      :type: cyclonedx.schema.SchemaVersion

      :abstractmethod:



   .. py:method:: get_schema_version() -> str


.. py:class:: JsonV1Dot1(bom: cyclonedx.model.bom.Bom)

   Bases: :py:obj:`Json`, :py:obj:`cyclonedx.schema.schema.SchemaVersion1Dot1`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:property:: schema_version
      :type: cyclonedx.schema.SchemaVersion



   .. py:property:: output_format
      :type: Literal[cyclonedx.schema.OutputFormat.JSON]



   .. py:method:: generate(force_regeneration: bool = False) -> None


   .. py:method:: output_as_string(*, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> str


   .. py:property:: generated
      :type: bool



   .. py:method:: get_bom() -> cyclonedx.model.bom.Bom


   .. py:method:: set_bom(bom: cyclonedx.model.bom.Bom) -> None


   .. py:method:: output_to_file(filename: str, allow_overwrite: bool = False, *, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> None


   .. py:property:: schema_version_enum
      :type: cyclonedx.schema.SchemaVersion

      :abstractmethod:



   .. py:method:: get_schema_version() -> str


.. py:class:: JsonV1Dot2(bom: cyclonedx.model.bom.Bom)

   Bases: :py:obj:`Json`, :py:obj:`cyclonedx.schema.schema.SchemaVersion1Dot2`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:property:: schema_version
      :type: cyclonedx.schema.SchemaVersion



   .. py:property:: output_format
      :type: Literal[cyclonedx.schema.OutputFormat.JSON]



   .. py:method:: generate(force_regeneration: bool = False) -> None


   .. py:method:: output_as_string(*, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> str


   .. py:property:: generated
      :type: bool



   .. py:method:: get_bom() -> cyclonedx.model.bom.Bom


   .. py:method:: set_bom(bom: cyclonedx.model.bom.Bom) -> None


   .. py:method:: output_to_file(filename: str, allow_overwrite: bool = False, *, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> None


   .. py:property:: schema_version_enum
      :type: cyclonedx.schema.SchemaVersion

      :abstractmethod:



   .. py:method:: get_schema_version() -> str


.. py:class:: JsonV1Dot3(bom: cyclonedx.model.bom.Bom)

   Bases: :py:obj:`Json`, :py:obj:`cyclonedx.schema.schema.SchemaVersion1Dot3`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:property:: schema_version
      :type: cyclonedx.schema.SchemaVersion



   .. py:property:: output_format
      :type: Literal[cyclonedx.schema.OutputFormat.JSON]



   .. py:method:: generate(force_regeneration: bool = False) -> None


   .. py:method:: output_as_string(*, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> str


   .. py:property:: generated
      :type: bool



   .. py:method:: get_bom() -> cyclonedx.model.bom.Bom


   .. py:method:: set_bom(bom: cyclonedx.model.bom.Bom) -> None


   .. py:method:: output_to_file(filename: str, allow_overwrite: bool = False, *, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> None


   .. py:property:: schema_version_enum
      :type: cyclonedx.schema.SchemaVersion

      :abstractmethod:



   .. py:method:: get_schema_version() -> str


.. py:class:: JsonV1Dot4(bom: cyclonedx.model.bom.Bom)

   Bases: :py:obj:`Json`, :py:obj:`cyclonedx.schema.schema.SchemaVersion1Dot4`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:property:: schema_version
      :type: cyclonedx.schema.SchemaVersion



   .. py:property:: output_format
      :type: Literal[cyclonedx.schema.OutputFormat.JSON]



   .. py:method:: generate(force_regeneration: bool = False) -> None


   .. py:method:: output_as_string(*, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> str


   .. py:property:: generated
      :type: bool



   .. py:method:: get_bom() -> cyclonedx.model.bom.Bom


   .. py:method:: set_bom(bom: cyclonedx.model.bom.Bom) -> None


   .. py:method:: output_to_file(filename: str, allow_overwrite: bool = False, *, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> None


   .. py:property:: schema_version_enum
      :type: cyclonedx.schema.SchemaVersion

      :abstractmethod:



   .. py:method:: get_schema_version() -> str


.. py:class:: JsonV1Dot5(bom: cyclonedx.model.bom.Bom)

   Bases: :py:obj:`Json`, :py:obj:`cyclonedx.schema.schema.SchemaVersion1Dot5`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:property:: schema_version
      :type: cyclonedx.schema.SchemaVersion



   .. py:property:: output_format
      :type: Literal[cyclonedx.schema.OutputFormat.JSON]



   .. py:method:: generate(force_regeneration: bool = False) -> None


   .. py:method:: output_as_string(*, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> str


   .. py:property:: generated
      :type: bool



   .. py:method:: get_bom() -> cyclonedx.model.bom.Bom


   .. py:method:: set_bom(bom: cyclonedx.model.bom.Bom) -> None


   .. py:method:: output_to_file(filename: str, allow_overwrite: bool = False, *, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> None


   .. py:property:: schema_version_enum
      :type: cyclonedx.schema.SchemaVersion

      :abstractmethod:



   .. py:method:: get_schema_version() -> str


.. py:class:: JsonV1Dot6(bom: cyclonedx.model.bom.Bom)

   Bases: :py:obj:`Json`, :py:obj:`cyclonedx.schema.schema.SchemaVersion1Dot6`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:property:: schema_version
      :type: cyclonedx.schema.SchemaVersion



   .. py:property:: output_format
      :type: Literal[cyclonedx.schema.OutputFormat.JSON]



   .. py:method:: generate(force_regeneration: bool = False) -> None


   .. py:method:: output_as_string(*, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> str


   .. py:property:: generated
      :type: bool



   .. py:method:: get_bom() -> cyclonedx.model.bom.Bom


   .. py:method:: set_bom(bom: cyclonedx.model.bom.Bom) -> None


   .. py:method:: output_to_file(filename: str, allow_overwrite: bool = False, *, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> None


   .. py:property:: schema_version_enum
      :type: cyclonedx.schema.SchemaVersion

      :abstractmethod:



   .. py:method:: get_schema_version() -> str


.. py:class:: JsonV1Dot7(bom: cyclonedx.model.bom.Bom)

   Bases: :py:obj:`Json`, :py:obj:`cyclonedx.schema.schema.SchemaVersion1Dot7`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:property:: schema_version
      :type: cyclonedx.schema.SchemaVersion



   .. py:property:: output_format
      :type: Literal[cyclonedx.schema.OutputFormat.JSON]



   .. py:method:: generate(force_regeneration: bool = False) -> None


   .. py:method:: output_as_string(*, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> str


   .. py:property:: generated
      :type: bool



   .. py:method:: get_bom() -> cyclonedx.model.bom.Bom


   .. py:method:: set_bom(bom: cyclonedx.model.bom.Bom) -> None


   .. py:method:: output_to_file(filename: str, allow_overwrite: bool = False, *, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> None


   .. py:property:: schema_version_enum
      :type: cyclonedx.schema.SchemaVersion

      :abstractmethod:



   .. py:method:: get_schema_version() -> str


.. py:data:: BY_SCHEMA_VERSION
   :type:  dict[cyclonedx.schema.SchemaVersion, type[Json]]

