juzu.impl.template.spi.TemplateProvider Maven / Gradle / Ivy
/*
* Copyright 2013 eXo Platform SAS
*
* 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 juzu.impl.template.spi;
import java.io.IOException;
import java.io.Serializable;
/**
* A provider for templating system.
*
* @author Julien Viet
* @param the template model
*/
public abstract class TemplateProvider {
// tag::getSourceExtension[]
/**
* Returns the template source extension without the dot recognised by
* this provider. For instance it should return gtmpl
* for groovy templates.
*
* @return the source extension
*/
public abstract String getSourceExtension();
// end::getSourceExtension[]
// tag::getTemplateStubType[]
/**
* Return the template stub type.
*
* @return the template stub class
*/
public abstract Class getTemplateStubType();
// end::getTemplateStubType[]
// tag::parse[]
/**
* Parse the provided char sequence and return the corresponding template model.
*
* @param context the parse context
* @param source the source to parse
* @return the corresponding template model
* @throws TemplateException any template related exception
*/
public abstract M parse(
ParseContext context,
CharSequence source) throws TemplateException;
// end::parse[]
// tag::process[]
/**
* Process the template.
*
* @param context the process context
* @param templateModel the template to process
* @throws TemplateException any template related exception
*/
public abstract void process(
ProcessContext context,
TemplateModel templateModel) throws TemplateException;
// end::process[]
// tag::emit[]
/**
* Provide an opportunity for emitting a file on the disk.
*
* @param context the emit context
* @param templateModel the template
* @throws TemplateException any template related exception
* @throws IOException any io exception
*/
public abstract void emit(
EmitContext context,
TemplateModel templateModel) throws TemplateException, IOException;
// end::emit[]
}