org.eclipse.mylyn.wikitext.parser.builder.HtmlDocumentHandler Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (c) 2013 Tasktop Technologies and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     David Green - initial API and implementation
 *******************************************************************************/

package org.eclipse.mylyn.wikitext.parser.builder;

import org.eclipse.mylyn.wikitext.util.XmlStreamWriter;

/**
 * An extension of {@link HtmlDocumentBuilder} which is responsible for emitting the HTML document tags and content
 * which wrap the body's content. Normally this would include the {@code } and {@code } tags, however
 * implementations may emit any content.
 * 
 * Example implementation:
 * 
 *
 *  * 
 * class MyHtmlDocumentHandler implements HtmlDocumentHandler {
 *
 * 	@Override
 * 	public void beginDocument(HtmlDocumentBuilder builder, XmlStreamWriter writer) {
 * 		writer.writeStartDocument("utf-8", "1.0");
 * 		writer.writeStartElement(builder.getHtmlNsUri(), "html");
 * 		writer.writeDefaultNamespace(builder.getHtmlNsUri());
 * 		writer.writeStartElement(builder.getHtmlNsUri(), "body");
 * 	}
 *
 * 	@Override
 * 	public void endDocument(HtmlDocumentBuilder builder, XmlStreamWriter writer) {
 * 		writer.writeEndElement();
 * 		writer.writeEndElement();
 * 		writer.writeEndDocument();
 * 	}
 * }
 * 
 * 
 *
 * @author David Green
 * @since 3.0
 */
public interface HtmlDocumentHandler {
	/**
	 * Writes the content that occurs at the start of the document up to and including the {@code } tag (if any).
	 *
	 * @param builder
	 *            the builder the builder for which the handler is being invoked
	 * @param writer
	 *            the writer to which content is written
	 */
	void beginDocument(HtmlDocumentBuilder builder, XmlStreamWriter writer);

	/**
	 * Writes the content that occurs at the end of the document startign with the {@code } closing tag (if any).
	 *
	 * @param builder
	 *            the builder the builder for which the handler is being invoked
	 * @param writer
	 *            the writer to which content is written
	 */
	void endDocument(HtmlDocumentBuilder builder, XmlStreamWriter writer);
}