Module io.jstach.opt.spring

Package io.jstach.opt.spring

Class SpringJStachioExtension

java.lang.Object

io.jstach.opt.spring.SpringJStachioExtension

All Implemented Interfaces:

JStachioExtension, JStachioExtensionProvider

public class SpringJStachioExtension
extends Object
implements JStachioExtensionProvider

JStachio services based on Spring notably the config and template finding.

Author:

agentgt

API Note

Although this is an extension it is not designed to be loaded by the ServiceLoader.

Constructor Summary

Constructors

Constructor	Description
SpringJStachioExtension(JStachioConfig config, JStachioTemplateFinder templateFinder)	Constructor for injection
SpringJStachioExtension(Environment environment, List<Template<?>> templates)	Constructor for injection

Method Summary

Modifier and Type	Method	Description
static JStachioConfig	config(PropertyResolver propertyResolver)	Creates a JStachio config from a property resolver (usually Environment).
JStachioConfig	provideConfig()	Provide a config or not.
JStachioTemplateFinder	provideTemplateFinder()	Provide a template finder or not.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jstach.jstachio.spi.JStachioExtensionProvider

init, provideFilter

Constructor Details

SpringJStachioExtension

public SpringJStachioExtension(JStachioConfig config,
 JStachioTemplateFinder templateFinder)

Constructor for injection

Parameters:

config - jstachio config see config(PropertyResolver)

templateFinder - template finder to use

SpringJStachioExtension

public SpringJStachioExtension(Environment environment,
 List<Template<?>> templates)

Constructor for injection

Parameters:

environment - springs environment to be used for JStachioConfig

templates - templates found via spring

Method Details

config

public static JStachioConfig config(PropertyResolver propertyResolver)

Creates a JStachio config from a property resolver (usually Environment).

Parameters:

propertyResolver - wrapper property resolver

Returns:

config

provideConfig

public JStachioConfig provideConfig()

Provide a config or not. The final config is a composite of all the found configs.

Specifically if multiple instances of JStachioExtension are found that return a nonnull they will be combined by looping through all of them to find a nonnull value for JStachioConfig.getProperty(String). If no configs are provided or no services found JStachioExtensions instance will use the default config which uses System.getProperties(). The config comes from Spring Environment abstraction.

Specified by:

provideConfig in interface JStachioExtensionProvider

Returns:

config if this service provides one or null

provideTemplateFinder

public JStachioTemplateFinder provideTemplateFinder()

Provide a template finder or not. The final template finder is a composite of all the other ones found. See JStachioTemplateFinder.order() for ordering details.

If no template finders are provided then the default template finder that uses reflection and the ServiceLoader is used. The provided template finder instead of using reflection delegates to the templates wired in via spring.

Specified by:

provideTemplateFinder in interface JStachioExtensionProvider

Returns:

template finder or not