Interface DocRenderer


  • public interface DocRenderer
    Deprecated.
    Since 1.1, use DocumentRenderer instead.
    Base renderer interface for the document
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ROLE
      Deprecated.
      Plexus lookup.
    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.String getOutputExtension()
      Deprecated.
      Get the output extension supported
      void render​(java.io.File siteDirectory, java.io.File outputDirectory)
      Deprecated.
      Render all files from a site directory to an output directory
      void render​(java.io.File siteDirectory, java.io.File outputDirectory, java.io.File documentDescriptor)
      Deprecated.
      Render a document depending a context and a document descriptor
    • Field Detail

      • ROLE

        static final java.lang.String ROLE
        Deprecated.
        Plexus lookup.
    • Method Detail

      • render

        void render​(java.io.File siteDirectory,
                    java.io.File outputDirectory)
             throws DocumentRendererException,
                    java.io.IOException
        Deprecated.
        Render all files from a site directory to an output directory
        Parameters:
        siteDirectory - the input directory contains files to be generated
        outputDirectory - the output directory where files are generated
        Throws:
        DocumentRendererException - if any
        java.io.IOException - if any
      • render

        void render​(java.io.File siteDirectory,
                    java.io.File outputDirectory,
                    java.io.File documentDescriptor)
             throws DocumentRendererException,
                    java.io.IOException
        Deprecated.
        Render a document depending a context and a document descriptor
        Parameters:
        siteDirectory - the input directory contains files to be generated
        outputDirectory - the output directory where file are generated
        documentDescriptor - the document descriptor
        Throws:
        DocumentRendererException - if any
        java.io.IOException - if any
      • getOutputExtension

        java.lang.String getOutputExtension()
        Deprecated.
        Get the output extension supported
        Returns:
        the ouput extension supported