info.bliki.wiki.template.ITemplateFunction Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of bliki-core Show documentation

This is the core project.

The newest version!

package info.bliki.wiki.template;

import info.bliki.wiki.filter.TemplateParser;
import info.bliki.wiki.model.IWikiModel;

import java.io.IOException;
import java.util.List;

/**
 * Interface for a template parser function (i.e. {{ #if: ... }} )
 *
 */
public interface ITemplateFunction {

    /**
     * Parse a template function (like for example {{ #if: ... }}).
     *
     * The result is also a text string in Wikipedia syntax notation which will be
     * parsed again (recursively) in the TemplateParser step.
     *
     * @param parts
     *          the parser function arguments (extracted from the wiki text by
     *          splitting the string at the pipe symbol ´|´)
     * @param model
     *          the wiki model
     * @param src
     *          the array of the current Wikipedia source text.
     * @param beginIndex
     *          the beginning index, inclusive.
     * @param endIndex
     *          the ending index, exclusive.
     * @param isSubst
     *          if true the template function was called from
     *          subst or safesubst function and the arguments of
     *          the function are typically not parsed recursively.
     * @return the result string of this template function or null if
     *         the parsing fails or isn't valid.
     * @throws IOException
     * @see TemplateParser#parseTemplate(StringBuffer)
     */
    String parseFunction(List parts, IWikiModel model, char[] src, int beginIndex, int endIndex,
                         boolean isSubst) throws IOException;

    /**
     * Return a short description of the implemented template function
     *
     * @return
     */
    String getFunctionDoc();
}