cat.albirar.template.engine.models

Class TemplateInstanceBean

java.lang.Object

cat.albirar.template.engine.models.TemplateDefinitionBean

cat.albirar.template.engine.models.TemplateInstanceBean

All Implemented Interfaces:

Serializable

public class TemplateInstanceBean
extends TemplateDefinitionBean

The template definition with variables, messages and locale ready to render.

Since:

1.0.0

Author:

Octavi Fornés <ofornes@albirar.cat>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TemplateInstanceBean.TemplateInstanceBeanBuilder<C extends TemplateInstanceBean,B extends TemplateInstanceBean.TemplateInstanceBeanBuilder<C,B>>

Nested classes/interfaces inherited from class cat.albirar.template.engine.models.TemplateDefinitionBean

TemplateDefinitionBean.TemplateDefinitionBeanBuilder<C extends TemplateDefinitionBean,B extends TemplateDefinitionBean.TemplateDefinitionBeanBuilder<C,B>>

Field Summary

Fields inherited from class cat.albirar.template.engine.models.TemplateDefinitionBean

DEFAULT_CHARSET, DEFAULT_CONTENT_TYPE

Constructor Summary

Constructors

Modifier	Constructor and Description
	TemplateInstanceBean()
	TemplateInstanceBean(org.springframework.context.MessageSource messages, Map<String,Object> variables, Locale locale)
protected	TemplateInstanceBean(TemplateInstanceBean.TemplateInstanceBeanBuilder<?,?> b)

Method Summary

Modifier and Type	Method and Description
static TemplateInstanceBean.TemplateInstanceBeanBuilder<?,?>	builder()
static TemplateInstanceBean.TemplateInstanceBeanBuilder	buildInstance(TemplateDefinitionBean definition) Build an instance with Locale.getDefault() and without getMessages() and an empty getVariables().
static TemplateInstanceBean.TemplateInstanceBeanBuilder	buildInstance(TemplateDefinitionBean definition, Locale locale) Build an instance with locale and without getMessages() and an empty getVariables().
static TemplateInstanceBean.TemplateInstanceBeanBuilder	buildInstance(TemplateDefinitionBean definition, Locale locale, String baseNames) Build an instance with locale and a resource messages from baseNames and an empty getVariables().
static TemplateInstanceBean.TemplateInstanceBeanBuilder	buildInstance(TemplateDefinitionBean definition, String baseNames) Build an instance with default locale and a resource messages from baseNames and an empty getVariables().
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Locale	getLocale() The locale to use in i18n.
org.springframework.context.MessageSource	getMessages() Messages to use in i18n.
Map<String,Object>	getVariables() A map with key-values to apply on rendering.
int	hashCode()
void	setLocale(@NotNull Locale locale) The locale to use in i18n.
void	setMessages(@NotNull org.springframework.context.MessageSource messages) Messages to use in i18n.
void	setVariables(@NotNull Map<String,Object> variables) A map with key-values to apply on rendering.
TemplateInstanceBean.TemplateInstanceBeanBuilder<?,?>	toBuilder()
String	toString()

Methods inherited from class cat.albirar.template.engine.models.TemplateDefinitionBean

getCharSet, getContentType, getName, getTemplate, getTemplateEngineLanguage, setCharSet, setContentType, setName, setTemplate, setTemplateEngineLanguage

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TemplateInstanceBean

protected TemplateInstanceBean(TemplateInstanceBean.TemplateInstanceBeanBuilder<?,?> b)

TemplateInstanceBean

public TemplateInstanceBean()

TemplateInstanceBean

public TemplateInstanceBean(org.springframework.context.MessageSource messages,
                            Map<String,Object> variables,
                            Locale locale)

Method Detail

buildInstance

public static TemplateInstanceBean.TemplateInstanceBeanBuilder buildInstance(TemplateDefinitionBean definition)

Build an instance with Locale.getDefault() and without getMessages() and an empty getVariables().

Parameters:

definition - The template definition

locale - The locale

Returns:

The instance configured ready to parse

buildInstance

public static TemplateInstanceBean.TemplateInstanceBeanBuilder buildInstance(TemplateDefinitionBean definition,
                                                                             Locale locale)

Build an instance with locale and without getMessages() and an empty getVariables().

Parameters:

definition - The template definition

locale - The locale

Returns:

The instance configured ready to parse

buildInstance

public static TemplateInstanceBean.TemplateInstanceBeanBuilder buildInstance(TemplateDefinitionBean definition,
                                                                             String baseNames)

Build an instance with default locale and a resource messages from baseNames and an empty getVariables().

Parameters:

definition - The template definition

baseNames - The base names or messages for search for

Returns:

The instance configured ready to parse

buildInstance

public static TemplateInstanceBean.TemplateInstanceBeanBuilder buildInstance(TemplateDefinitionBean definition,
                                                                             Locale locale,
                                                                             String baseNames)

Build an instance with locale and a resource messages from baseNames and an empty getVariables().

Parameters:

definition - The template definition

locale - The locale

baseNames - The base names or messages for search for

Returns:

The instance configured ready to parse

builder

public static TemplateInstanceBean.TemplateInstanceBeanBuilder<?,?> builder()

toBuilder

public TemplateInstanceBean.TemplateInstanceBeanBuilder<?,?> toBuilder()

Overrides:

toBuilder in class TemplateDefinitionBean

getMessages

public org.springframework.context.MessageSource getMessages()

Messages to use in i18n.

Returns:

The message source to use

getVariables

public Map<String,Object> getVariables()

A map with key-values to apply on rendering.

Returns:

The map with values to use

getLocale

public Locale getLocale()

The locale to use in i18n.

Returns:

The locale to use

toString

public String toString()

Overrides:

toString in class TemplateDefinitionBean

equals

public boolean equals(Object o)

Overrides:

equals in class TemplateDefinitionBean

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class TemplateDefinitionBean

hashCode

public int hashCode()

Overrides:

hashCode in class TemplateDefinitionBean

setMessages

public void setMessages(@NotNull
                        @NotNull org.springframework.context.MessageSource messages)

Messages to use in i18n.

Parameters:

messages - The message source to use

setVariables

public void setVariables(@NotNull
                         @NotNull Map<String,Object> variables)

A map with key-values to apply on rendering.

Parameters:

variables - The map with values to use

setLocale

public void setLocale(@NotNull
                      @NotNull Locale locale)

The locale to use in i18n.

Parameters:

locale - The locale to use