Coverage Report - net.sourceforge.pebble.api.decorator.PageDecorator
 
Classes in this File Line Coverage Branch Coverage Complexity
PageDecorator
N/A
N/A
1
 
 1  
 /*
 2  
  * Copyright (c) 2003-2011, Simon Brown
 3  
  * All rights reserved.
 4  
  *
 5  
  * Redistribution and use in source and binary forms, with or without
 6  
  * modification, are permitted provided that the following conditions are met:
 7  
  *
 8  
  *   - Redistributions of source code must retain the above copyright
 9  
  *     notice, this list of conditions and the following disclaimer.
 10  
  *
 11  
  *   - Redistributions in binary form must reproduce the above copyright
 12  
  *     notice, this list of conditions and the following disclaimer in
 13  
  *     the documentation and/or other materials provided with the
 14  
  *     distribution.
 15  
  *
 16  
  *   - Neither the name of Pebble nor the names of its contributors may
 17  
  *     be used to endorse or promote products derived from this software
 18  
  *     without specific prior written permission.
 19  
  *
 20  
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 21  
  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 22  
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 23  
  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 24  
  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 25  
  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 26  
  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 27  
  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 28  
  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 29  
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 30  
  * POSSIBILITY OF SUCH DAMAGE.
 31  
  */
 32  
 
 33  
 package net.sourceforge.pebble.api.decorator;
 34  
 
 35  
 import javax.servlet.jsp.JspWriter;
 36  
 import java.io.IOException;
 37  
 import java.io.Writer;
 38  
 
 39  
 /**
 40  
  * Interface implemented by page decorators.  Can be used for plugins to add custom HTML to the head, top of the page,
 41  
  * and bottom of the page
 42  
  *
 43  
  * @author James Roper
 44  
  */
 45  
 public interface PageDecorator {
 46  
 
 47  
   /**
 48  
    * Decorate the head section of the page
 49  
    *
 50  
    * @param out The writer to write the decorations out to
 51  
    * @param pageDecoratorContext The context
 52  
    */
 53  
   void decorateHead(JspWriter out, PageDecoratorContext pageDecoratorContext) throws IOException;
 54  
 
 55  
   /**
 56  
    * Decorate the header (ie, just after the body tag start) section of the page
 57  
    *
 58  
    * @param out The writer to write the decorations out to
 59  
    * @param pageDecoratorContext The context
 60  
    */
 61  
   void decorateHeader(JspWriter out, PageDecoratorContext pageDecoratorContext) throws IOException;
 62  
 
 63  
   /**
 64  
    * Decorate the footer section of the page (ie, just before the body tag end)
 65  
    *
 66  
    * @param out The writer to write the decorations out to
 67  
    * @param pageDecoratorContext The context
 68  
    */
 69  
   void decorateFooter(JspWriter out, PageDecoratorContext pageDecoratorContext) throws IOException;
 70  
 }