Module io.jstach.jstachio

Package io.jstach.jstachio.spi

Class JStachioFactory.Builder

java.lang.Object

io.jstach.jstachio.spi.JStachioFactory.Builder

Enclosing class:

JStachioFactory

public static class JStachioFactory.Builder
extends Object

Builder for creating a custom JStachio.

 JStachio jstachio = JStachioFactory.builder()
     .add(extension1)
     .add(extension2)
     .build();
 

The order of adding extensions is important such that primacy order takes precedence as composite extensions such as config will be created if multiple of the same extension type are added. If you would like to share the JStachio in a service locator style you may want to set it as the default via JStachio.setStatic(java.util.function.Supplier) which will make all calls of JStachio.of() use the custom one.

Author:

agentgt

See Also:

• JStacheCatalog
• JStachioTemplateFinder
• JStachioConfig
• JStachio.setStatic(java.util.function.Supplier)

Method Summary

Modifier and Type	Method	Description
JStachioFactory.Builder	add(JStachioExtension extension)	Adds an extension
JStachioFactory.Builder	add(TemplateInfo template)	Registers an instantiated template.
JStachioFactory.Builder	add(Iterable<? extends JStachioExtension> extensions)	Add extensions.
JStachioFactory.Builder	add(Collection<? extends TemplateInfo> templates)	Registers instantiated templates.
JStachio	build()	Builds a JStachio by coalescing the extensions and registered templates.

Methods inherited from class java.lang.Object

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

Method Details

add

public JStachioFactory.Builder add(JStachioExtension extension)

Adds an extension

Parameters:

extension - not null

Returns:

this

add

public JStachioFactory.Builder add(Iterable<? extends JStachioExtension> extensions)

Add extensions. Useful for adding ServiceLoader results:

 
 builder.add(ServiceLoader.load(JStachioExtension.class));
  

Parameters:

extensions - not null

Returns:

this

add

public JStachioFactory.Builder add(TemplateInfo template)

Registers an instantiated template. The templates will be added to JStachioTemplateFinder with order -1 when build() is called.

Parameters:

template - usually a generated renderer.

Returns:

this

add

public JStachioFactory.Builder add(Collection<? extends TemplateInfo> templates)

Registers instantiated templates. The templates will be added JStachioTemplateFinder with order -1 when build() is called.

Parameters:

templates - usually a generated renderer.

Returns:

this

build

public JStachio build()

Builds a JStachio by coalescing the extensions and registered templates.

Returns:

resolved JStachio

API Note

See JStachioExtensions for logic on how the extensions are consolidated.