org.jastadd.tinytemplate.fragment.Fragment Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jastadd Show documentation
A metacompilation framework for Java using attribute grammars.
There is a newer version: 2.3.6
/* Copyright (c) 2013, Jesper Öqvist 
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the  nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL  BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.jastadd.tinytemplate.fragment;

import java.io.PrintStream;

import org.jastadd.tinytemplate.Indentation;
import org.jastadd.tinytemplate.TemplateContext;

/**
 * Template fragment.
 * @author Jesper Öqvist 
 */
public interface Fragment {

	/**
	 * Expand the fragment to a StringBuilder
	 * @param context
	 * @param buf
	 */
	void expand(TemplateContext context, StringBuilder buf);

	/**
	 * @return true if this fragment is empty
	 */
	boolean isEmpty();

	/**
	 * @return true if this fragment is a newline fragment
	 */
	boolean isNewline();

	/**
	 * @param var Name
	 * @return true if this fragment is a variable reference with the given name
	 */
	boolean isKeyword(String var);

	/**
	 * @return true if this fragment is whitespace
	 */
	boolean isWhitespace();

	/**
	 * @return true if this is a conditional statement
	 */
	boolean isConditional();

	/**
	 * @return true if this fragment is an expansion fragment
	 */
	public boolean isExpansion();

	/**
	 * @return true if this fragment is an indentation fragment
	 */
	boolean isIndentation();

	/**
	 * Print aspect code for this fragment to the given output stream
	 * @param ind Indentation handler
	 * @param lvl Indentation level
	 * @param out Output stream
	 */
	void printAspectCode(Indentation ind, int lvl, PrintStream out);
}