cat.albirar.template.engine.models

Class TemplateDefinitionBean

java.lang.Object

cat.albirar.template.engine.models.TemplateDefinitionBean

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

TemplateInstanceBean

public class TemplateDefinitionBean
extends Object
implements Serializable

The template definition bean.

Since:

1.0.0, 2.2.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	TemplateDefinitionBean.TemplateDefinitionBeanBuilder<C extends TemplateDefinitionBean,B extends TemplateDefinitionBean.TemplateDefinitionBeanBuilder<C,B>>

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CHARSET
static EContentType	DEFAULT_CONTENT_TYPE

Constructor Summary

Constructors

Modifier	Constructor and Description
	TemplateDefinitionBean()
	TemplateDefinitionBean(String name, String template, String templateEngineLanguage, EContentType contentType, Charset charSet)
protected	TemplateDefinitionBean(TemplateDefinitionBean.TemplateDefinitionBeanBuilder<?,?> b)

Method Summary

Modifier and Type	Method and Description
static TemplateDefinitionBean.TemplateDefinitionBeanBuilder<?,?>	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Charset	getCharSet() The charset of resulting content from this template.
EContentType	getContentType() The resulting content type of this template.
String	getName() A symbolic name for this template.
String	getTemplate() The template resource path, can be any of the resources resolved by ResourceLoader.getResource(String).
String	getTemplateEngineLanguage() The template engine language.
int	hashCode()
void	setCharSet(@NotNull Charset charSet) The charset of resulting content from this template.
void	setContentType(@NotNull EContentType contentType) The resulting content type of this template.
void	setName(@NotBlank String name) A symbolic name for this template.
void	setTemplate(@NotBlank String template) The template resource path, can be any of the resources resolved by ResourceLoader.getResource(String).
void	setTemplateEngineLanguage(@NotBlank String templateEngineLanguage) The template engine language.
TemplateDefinitionBean.TemplateDefinitionBeanBuilder<?,?>	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CHARSET

public static final String DEFAULT_CHARSET

See Also:

Constant Field Values

DEFAULT_CONTENT_TYPE

public static final EContentType DEFAULT_CONTENT_TYPE

Constructor Detail

TemplateDefinitionBean

protected TemplateDefinitionBean(TemplateDefinitionBean.TemplateDefinitionBeanBuilder<?,?> b)

TemplateDefinitionBean

public TemplateDefinitionBean()

TemplateDefinitionBean

public TemplateDefinitionBean(String name,
                              String template,
                              String templateEngineLanguage,
                              EContentType contentType,
                              Charset charSet)

Method Detail

builder

public static TemplateDefinitionBean.TemplateDefinitionBeanBuilder<?,?> builder()

toBuilder

public TemplateDefinitionBean.TemplateDefinitionBeanBuilder<?,?> toBuilder()

getName

public String getName()

A symbolic name for this template.

getTemplate

public String getTemplate()

The template resource path, can be any of the resources resolved by ResourceLoader.getResource(String).

Returns:

The template resource path

See Also:

ResourceLoader.getResource(String)

getTemplateEngineLanguage

public String getTemplateEngineLanguage()

The template engine language. Identify the engine capable of transform the given template

getContentType

public EContentType getContentType()

The resulting content type of this template.

getCharSet

public Charset getCharSet()

The charset of resulting content from this template.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

setName

public void setName(@NotBlank
                    @NotBlank String name)

A symbolic name for this template.

setTemplate

public void setTemplate(@NotBlank
                        @NotBlank String template)

The template resource path, can be any of the resources resolved by ResourceLoader.getResource(String).

Parameters:

template - The template resource path

See Also:

ResourceLoader.getResource(String)

setTemplateEngineLanguage

public void setTemplateEngineLanguage(@NotBlank
                                      @NotBlank String templateEngineLanguage)

The template engine language. Identify the engine capable of transform the given template

setContentType

public void setContentType(@NotNull
                           @NotNull EContentType contentType)

The resulting content type of this template.

setCharSet

public void setCharSet(@NotNull
                       @NotNull Charset charSet)

The charset of resulting content from this template.