TemplateData

java.lang.Object

io.github.erdos.stencil.TemplateData

public final class TemplateData extends Object

Contains data to fill template documents. Immutable.

Method Summary

Modifier and Type

Method

Description

static TemplateData

empty()

Construct a new empty template data object.

static TemplateData

fromMap(Map<String,Object> data)

Constructs a template data instance holding a map data structure.

Map<String,Object>

getData()

Returns contained data as a possibly nested map.

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

Method Details
- empty
  
  public static TemplateData empty()
  
  Construct a new empty template data object.
- fromMap
  
  public static TemplateData fromMap(Map<String,Object> data)
  
  Constructs a template data instance holding a map data structure.
  
  Parameters:
  
  data - map of template data. Possibly nested: values might contain maps or vectors recursively.
  
  Returns:
  
  constructed data holder. Never null.
  
  Throws:
  
  IllegalArgumentException - when input is null
- getData
  
  public Map<String,Object> getData()
  
  Returns contained data as a possibly nested map.
  
  Returns:
  
  template data map. Not null.