Interface ReportSerializerPlugin


  • @ProviderType
    public interface ReportSerializerPlugin
    This plugin serialize the extracted DTO report into a specific format.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String[] getHandledExtensions()
      Get the set of file extension names corresponding to the format that this plugin can serialize to.
      void serialize​(java.util.Map<java.lang.String,​java.lang.Object> reportDTO, java.io.OutputStream output)
      Serialize the DTO report into the output stream.
    • Method Detail

      • getHandledExtensions

        java.lang.String[] getHandledExtensions()
        Get the set of file extension names corresponding to the format that this plugin can serialize to.
        Returns:
        one or multiple extensions name, never null
      • serialize

        void serialize​(java.util.Map<java.lang.String,​java.lang.Object> reportDTO,
                       java.io.OutputStream output)
                throws java.lang.Exception
        Serialize the DTO report into the output stream.
        Parameters:
        reportDTO - the DTO report to serialize, must not be null
        output - the output stream to write the serialization result, must not be null
        Throws:
        java.lang.Exception - if any errors occur during the serialization process