Coverage Report - org.apache.tapestry.markup.MarkupFilter
 
Classes in this File Line Coverage Branch Coverage Complexity
MarkupFilter
N/A
N/A
1
 
 1  
 // Copyright 2005 The Apache Software Foundation
 2  
 //
 3  
 // Licensed under the Apache License, Version 2.0 (the "License");
 4  
 // you may not use this file except in compliance with the License.
 5  
 // You may obtain a copy of the License at
 6  
 //
 7  
 //     http://www.apache.org/licenses/LICENSE-2.0
 8  
 //
 9  
 // Unless required by applicable law or agreed to in writing, software
 10  
 // distributed under the License is distributed on an "AS IS" BASIS,
 11  
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 12  
 // See the License for the specific language governing permissions and
 13  
 // limitations under the License.
 14  
 
 15  
 package org.apache.tapestry.markup;
 16  
 
 17  
 import java.io.PrintWriter;
 18  
 
 19  
 /**
 20  
  * Filter used with {@link org.apache.tapestry.markup.MarkupWriterImpl}to determine how to convert
 21  
  * the output into a format compatible with the content type. Typically, this means translating
 22  
  * certain characters into escape codes (for example, in HTML, convert '<' to '<'.
 23  
  * <p>
 24  
  * Implementations should be stateless and thread safe.
 25  
  * 
 26  
  * @author Howard M. Lewis Ship
 27  
  * @since 4.0
 28  
  */
 29  
 public interface MarkupFilter
 30  
 {
 31  
     /**
 32  
      * Print the value to the writer, escaping characters as necessary.
 33  
      * 
 34  
      * @param writer
 35  
      *            the write to which converted content should be output
 36  
      * @param data
 37  
      *            a character array containing the characters to be output
 38  
      * @param offset
 39  
      *            the offset within the array to begin output
 40  
      * @param length
 41  
      *            the number of characters to output
 42  
      * @param escapeQuotes
 43  
      *            if true, the value is being rendered as an attribute value and double quotes
 44  
      *            within the value should be escaped. If false, then then double quotes may pass
 45  
      *            through unchanged.
 46  
      */
 47  
 
 48  
     void print(PrintWriter writer, char[] data, int offset, int length, boolean escapeQuotes);
 49  
 
 50  
 }