StringTemplate.java

/*
 * Copyright 2010 the original author or authors.
 *
 * 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 org.springframework.templating;

/**
 * A template that generates text document as a String from a map of model attributes.
 * Stateful and not designed to be shared between threads.
 * @author Keith Donald
 */
public interface StringTemplate {
	
	/**
	 * Put an attribute in the model of this template.
	 */
	void put(String attribute, Object value);

	/**
	 * Generate the final text by rendering this template.
	 * Model attributes referenced in the template have their values resolved during rendering.
	 */
	String render();
	
}