cyclonedx.validation.xml
========================

.. py:module:: cyclonedx.validation.xml


Classes
-------

.. autoapisummary::

   cyclonedx.validation.xml.XmlValidator


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

.. py:class:: XmlValidator(schema_version: cyclonedx.schema.SchemaVersion)

   Bases: :py:obj:`_BaseXmlValidator`, :py:obj:`cyclonedx.validation.BaseSchemabasedValidator`, :py:obj:`cyclonedx.validation.SchemabasedValidator`


   Validator for CycloneDX documents in XML format.


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


      Get the format.



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


      Get the schema version.



   .. py:method:: validate_str(data: str) -> Optional[ValidationError]

      Validate a string

      :param data: the data string to validate
      :return: validation error
      :retval None: if ``data`` is valid
      :retval ValidationError:  if ``data`` is invalid



