TemplateVariables

java.lang.Object

io.github.erdos.stencil.TemplateVariables

public final class TemplateVariables extends Object

Holds information about variables found in template file. Can be used to validate template data.

A variable path looks like the following. A.B.C[].D

A path is a string that contains tokens separated with . (dot) characters. The tokens represents keys in maps.

Method Summary

Modifier and Type

Method

Description

static TemplateVariables

fromPaths(Collection<String> allVariablePaths, Collection<String> allFragmentNames)

Set<String>

getAllFragmentNames()

Set<String>

getAllVariables()

Returns all variable paths as an immutable set.

void

throwWhenInvalid(TemplateData templateData)

Throws IllegalArgumentException exception when template data is missing values for schema.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- fromPaths
  
  public static TemplateVariables fromPaths(Collection<String> allVariablePaths, Collection<String> allFragmentNames)
- getAllVariables
  
  public Set<String> getAllVariables()
  
  Returns all variable paths as an immutable set.
- getAllFragmentNames
  
  public Set<String> getAllFragmentNames()
- throwWhenInvalid
  
  public void throwWhenInvalid(TemplateData templateData) throws IllegalArgumentException
  
  Throws IllegalArgumentException exception when template data is missing values for schema.
  Throws when referred keys are missing from data.
  
  Throws:
  
  IllegalArgumentException - then parameter does not match pattern
  
  NullPointerException - when parameter is null.