Class TemplateAvailabilityProviders

java.lang.Object

org.springframework.boot.autoconfigure.template.TemplateAvailabilityProviders

public class TemplateAvailabilityProviders
extends Object

Collection of TemplateAvailabilityProvider beans that can be used to check which (if any) templating engine supports a given view. Caches responses unless the spring.template.provider.cache property is set to false.

Since:

1.4.0

Author:

Phillip Webb, Madhura Bhave

Constructor Summary

Constructors

Modifier	Constructor	Description
	TemplateAvailabilityProviders(ClassLoader classLoader)	Create a new TemplateAvailabilityProviders instance.
protected	TemplateAvailabilityProviders(Collection<? extends TemplateAvailabilityProvider> providers)	Create a new TemplateAvailabilityProviders instance.
	TemplateAvailabilityProviders(ApplicationContext applicationContext)	Create a new TemplateAvailabilityProviders instance.

Method Summary

Modifier and Type	Method	Description
@Nullable TemplateAvailabilityProvider	getProvider(String view, ApplicationContext applicationContext)	Get the provider that can be used to render the given view.
@Nullable TemplateAvailabilityProvider	getProvider(String view, Environment environment, ClassLoader classLoader, ResourceLoader resourceLoader)	Get the provider that can be used to render the given view.
List<TemplateAvailabilityProvider>	getProviders()	Return the underlying providers being used.

Methods inherited from class Object

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

Constructor Details

TemplateAvailabilityProviders

public TemplateAvailabilityProviders(ApplicationContext applicationContext)

Create a new TemplateAvailabilityProviders instance.

Parameters:

applicationContext - the source application context

TemplateAvailabilityProviders

public TemplateAvailabilityProviders(ClassLoader classLoader)

Create a new TemplateAvailabilityProviders instance.

Parameters:

classLoader - the source class loader

TemplateAvailabilityProviders

protected TemplateAvailabilityProviders(Collection<? extends TemplateAvailabilityProvider> providers)

Create a new TemplateAvailabilityProviders instance.

Parameters:

providers - the underlying providers

Method Details

getProviders

public List<TemplateAvailabilityProvider> getProviders()

Return the underlying providers being used.

Returns:

the providers being used

getProvider

public @Nullable TemplateAvailabilityProvider getProvider(String view,
 ApplicationContext applicationContext)

Get the provider that can be used to render the given view.

Parameters:

view - the view to render

applicationContext - the application context

Returns:

a TemplateAvailabilityProvider or null

getProvider

public @Nullable TemplateAvailabilityProvider getProvider(String view,
 Environment environment,
 ClassLoader classLoader,
 ResourceLoader resourceLoader)

Get the provider that can be used to render the given view.

Parameters:

view - the view to render

environment - the environment

classLoader - the class loader

resourceLoader - the resource loader

Returns:

a TemplateAvailabilityProvider or null