de.vandermeer.skb.base.utils

Class Skb_STUtils

java.lang.Object

de.vandermeer.skb.base.utils.Skb_STUtils

public abstract class Skb_STUtils
extends Object

Utilities for ST4 templates and template groups.

Version:

v0.0.3 build 150618 (18-Jun-15) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Constructor Summary

Constructors

Constructor and Description
Skb_STUtils()

Method Summary

Modifier and Type	Method and Description
static Map<String,List<String>>	getMissingChunks(org.stringtemplate.v4.STGroup stg, Map<String,List<String>> expectedChunks) Returns a map of missing templates and/or missing arguments of templates.
static Set<String>	getMissingChunksErrorMessages(String name, Map<String,List<String>> missingChunks) Returns a set of detailed error messages for missing chunks
static List<String>	getMissingSTArguments(org.stringtemplate.v4.ST st, List<String> expectedArguments) Returns a list of arguments missing in the given StringTemplate.
static String	getStgName(org.stringtemplate.v4.STGroup stg) Returns the name of the STGroup.

Methods inherited from class java.lang.Object

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

Constructor Detail

Skb_STUtils

public Skb_STUtils()

Method Detail

getMissingChunks

public static final Map<String,List<String>> getMissingChunks(org.stringtemplate.v4.STGroup stg,
                                                              Map<String,List<String>> expectedChunks)

Returns a map of missing templates and/or missing arguments of templates. In detail, the given chunk list is tested against all templates of the template group and missing templates and/or missing arguments of a template are returned.

Parameters:

stg - template group to be tested

expectedChunks - expected arguments - map key is the expected template name and the associated list are the expected arguments

Returns:

empty map if nothing is missing, non-empty map otherwise. If the map is not empty, then a mapping of a string to null indicates that the template did not exist at all while a mapping of a string to a list indicates that the template did exist but the arguments noted in the list were missing.

getMissingSTArguments

public static final List<String> getMissingSTArguments(org.stringtemplate.v4.ST st,
                                                       List<String> expectedArguments)

Returns a list of arguments missing in the given StringTemplate. In detail, the given argument list is tested against the formal arguments of the given StringTemplate. Any arguments not defined by the StringTemplate will be added to the returned list.

Parameters:

st - template to be tested

expectedArguments - list of expected arguments

Returns:

null if input parameters are null, empty list if all arguments are declared by the template, non-empty list if any expected argument is not declared in the template

getMissingChunksErrorMessages

public static final Set<String> getMissingChunksErrorMessages(String name,
                                                              Map<String,List<String>> missingChunks)

Returns a set of detailed error messages for missing chunks

Parameters:

name - name of the STGroup with missing templates (null is valid)

missingChunks - list of missing chunks

Returns:

a set of error messages detailing the problems, set is of size 0 if no missing chunks

getStgName

public static final String getStgName(org.stringtemplate.v4.STGroup stg)

Returns the name of the STGroup. Any file extension will be removed from the returned name.

Parameters:

stg - STGroup

Returns:

name of the group or null