BlockEmitter.java

/*
 * Copyright (C) 2011 René Jeschke <rene_jeschke@yahoo.de>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.kaif.kmark;

import java.util.List;

/**
 * Block emitter interface. An example for a code block emitter is given below:
 * <p>
 * <pre>
 * <code>public void emitBlock(StringBuilder out, List<String> lines, String meta)
 * {
 *     out.append("<pre><code>");
 *     for(final String s : lines)
 *     {
 *         for(int i = 0; i < s.length(); i++)
 *         {
 *             final char c = s.charAt(i);
 *             switch(c)
 *             {
 *             case '&':
 *                 out.append("&amp;");
 *                 break;
 *             case '<':
 *                 out.append("&lt;");
 *                 break;
 *             case '>':
 *                 out.append("&gt;");
 *                 break;
 *             default:
 *                 out.append(c);
 *                 break;
 *             }
 *         }
 *         out.append('\n');
 *     }
 *     out.append("</code></pre>\n");
 * }
 * </code>
 * </pre>
 *
 * @author René Jeschke <rene_jeschke@yahoo.de>
 * @since 0.7
 */
public interface BlockEmitter {

  /**
   * This method is responsible for outputting a markdown block and for any
   * needed pre-processing like escaping HTML special characters.
   *
   * @param out
   *     The StringBuilder to append to
   * @param lines
   *     List of lines
   * @param meta
   *     Meta information as a single String (if any) or empty String
   */
  public void emitBlock(HtmlEscapeStringBuilder out, List<String> lines, String meta);
}