Package com.day.cq.commons.feed

Interface Feed

All Known Implementing Classes:
AbstractFeed, AtomFeed, RssFeed
public interface Feed
The Feed interface is used to print a resource as a feed.

  • Field Details

  • Method Details

    • getContentType

      String getContentType()
      Returns the content type of the feed.
      Returns:
      The type

    • getCharacterEncoding

      String getCharacterEncoding()
      Returns the character encoding of the feed.
      Returns:
      The encoding

    • printHeader

      void printHeader() throws IOException
      Writes the feed header.
      Throws:
      IOException - If output fails

    • printEntry

      void printEntry() throws IOException
      Prints the current resource as a feed entry.
      Throws:
      IOException - If output fails

    • printEntry

      void printEntry(Resource res) throws IOException
      Prints the specified resource as a feed entry
      Parameters:
      res - the resource
      Throws:
      IOException - If output fails

    • printChildEntries

      void printChildEntries() throws IOException
      Prints the children of the current resource as feed entries
      Throws:
      IOException - If output fails

    • printChildEntries

      void printChildEntries(int max) throws IOException
      Prints the children of the current resource as feed entries
      Parameters:
      max - The maximum number of entries
      Throws:
      IOException - If output fails

    • printEntries

      void printEntries(Iterator<Resource> iter) throws IOException
      Prints the specified resources as feed entries
      Parameters:
      iter - The resources
      Throws:
      IOException - If output fails

    • printEntries

      void printEntries(Iterator<Resource> iter, int max) throws IOException
      Prints the specified resources as feed entries
      Parameters:
      iter - The resources
      max - The maximum number of entries
      Throws:
      IOException - If output fails

    • printFooter

      void printFooter() throws IOException
      Writes the feed footer.
      Throws:
      IOException - If output fails