Package org.apache.sling.junit

Interface Renderer

  • All Known Implementing Classes:
    SerializedRenderer
    public interface Renderer
    Renderer for our servlet output. Should not be used directly for rendering as it leads to non-reentrant renderers. Use only via RendererFactory as RendererSelectorImpl does

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean appliesTo​(TestSelector selector)
      True if this renderer applies to supplied request
      void cleanup()
      Called once rendering is done
      java.lang.String getExtension()
      Return the extension that triggers this renderer
      org.junit.runner.notification.RunListener getRunListener()
      Provide a RunListener for JUnit tests
      void info​(java.lang.String role, java.lang.String info)
      Render general information
      void link​(java.lang.String info, java.lang.String url, java.lang.String method)
      Render a link to specified URL using specified HTTP method
      void list​(java.lang.String role, java.util.Collection<java.lang.String> data)
      Render a list of things
      void setup​(javax.servlet.http.HttpServletResponse response, java.lang.String pageTitle)
      Called first to setup rendering
      void title​(int level, java.lang.String title)
      Render a title of a specified hierarchical level

    • Method Detail

      • appliesTo

        boolean appliesTo​(TestSelector selector)
        True if this renderer applies to supplied request

      • setup

        void setup​(javax.servlet.http.HttpServletResponse response,
           java.lang.String pageTitle)
    throws java.io.IOException,
           java.io.UnsupportedEncodingException
        Called first to setup rendering
        Throws:
        java.io.IOException
        java.io.UnsupportedEncodingException

      • cleanup

        void cleanup()
        Called once rendering is done

      • list

        void list​(java.lang.String role,
          java.util.Collection<java.lang.String> data)
        Render a list of things
        Parameters:
        role - describes the role of the list, must be a valid CSS class value

      • info

        void info​(java.lang.String role,
          java.lang.String info)
        Render general information
        Parameters:
        role - describes the role of the list, must be a valid CSS class value

      • title

        void title​(int level,
           java.lang.String title)
        Render a title of a specified hierarchical level

      • link

        void link​(java.lang.String info,
          java.lang.String url,
          java.lang.String method)
        Render a link to specified URL using specified HTTP method

      • getRunListener

        org.junit.runner.notification.RunListener getRunListener()
        Provide a RunListener for JUnit tests

      • getExtension

        java.lang.String getExtension()
        Return the extension that triggers this renderer