b4j.util

Class Templating

java.lang.Object

b4j.util.Templating

public class Templating
extends Object

Implements templating methods similar to Typo3. Simple tag markers must be upper-case. The must appear in templates embraced by three hash signs, e.g. ###MARKER###

Author:

Ralph Schuster

Constructor Summary

Constructors

Constructor and Description
Templating()

Method Summary

Methods

Modifier and Type	Method and Description
static String	getSubTemplate(String template, String name) Returns a sub template.
static String	getTemplate(File f) Returns a template from a file.
static String	getTemplate(String filename) Returns a template from a file.
static String	replace(String template, Map<String,Object> markers) Replaces multiple simple tag markers.
static String	replace(String template, String marker, Object value) Replaces a simple marker by its value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Templating

public Templating()

Method Detail

replace

public static String replace(String template,
             String marker,
             Object value)

Replaces a simple marker by its value. Simple tag markers must be upper-case. The must appear in templates embraced by three hash signs, e.g. ###MARKER###

Parameters:

template - - text template

marker - - marker name, e.g. MARKER

value - - value to be replaced

Returns:

the template string with all marker's occurrences replaced

replace

public static String replace(String template,
             Map<String,Object> markers)

Replaces multiple simple tag markers. Simple tag markers must be upper-case. The must appear in templates embraced by three hash signs, e.g. ###MARKER###

Parameters:

template - - text template

markers - - markers map

Returns:

- replaced template text

getSubTemplate

public static String getSubTemplate(String template,
                    String name)

Returns a sub template. Sub templates are enclosed by XML comment tags as known from TYPO3: <!-- ###MARKER### begin> my sub template text <!-- ###MARKER### end> Sub templates of same name are not allowed

Parameters:

template - - parent template

name - - name of sub template, e.g. MARKER

Returns:

sub template, or null if not found

getTemplate

public static String getTemplate(String filename)
                          throws IOException

Returns a template from a file.

Parameters:

filename - - filename

Returns:

template's content

Throws:

IOException - when an error occurred

getTemplate

public static String getTemplate(File f)
                          throws IOException

Returns a template from a file.

Parameters:

f - - file to load

Returns:

template's content

Throws:

IOException - when an error occurred