Package io.quarkus.qute.runtime

Class QuteConfig

java.lang.Object

io.quarkus.qute.runtime.QuteConfig

@ConfigRoot(phase=BUILD_AND_RUN_TIME_FIXED)
public class QuteConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Map<String,String>	contentTypes	The additional map of suffixes to content types.
Charset	defaultCharset	The default charset of the templates files.
List<String>	escapeContentTypes	The list of content types for which the ', ", <, > and & characters are escaped if a template variant is set.
String	iterationMetadataPrefix	The prefix is used to access the iteration metadata inside a loop section.
List<String>	suffixes	The list of suffixes used when attempting to locate a template file.
Pattern	templatePathExclude	This regular expression is used to exclude template files from the templates directory.
Optional<List<String>>	typeCheckExcludes	The list of exclude rules used to intentionally ignore some parts of an expression when performing type-safe validation.

Constructor Summary

Constructors

Constructor	Description
QuteConfig()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

suffixes

@ConfigItem(defaultValue="qute.html,qute.txt,html,txt")
public List<String> suffixes

The list of suffixes used when attempting to locate a template file. By default, `engine.getTemplate("foo")` would result in several lookups: `foo`, `foo.html`, `foo.txt`, etc.

contentTypes

@ConfigItem
public Map<String,String> contentTypes

The additional map of suffixes to content types. This map is used when working with template variants. By default, the URLConnection.getFileNameMap() is used to determine the content type of a template file.

typeCheckExcludes

@ConfigItem
public Optional<List<String>> typeCheckExcludes

The list of exclude rules used to intentionally ignore some parts of an expression when performing type-safe validation.

An element value must have at least two parts separated by dot. The last part is used to match the property/method name. The prepended parts are used to match the class name. The value * can be used to match any name.

Examples:

• org.acme.Foo.name - exclude the property/method name on the org.acme.Foo class
• org.acme.Foo.* - exclude any property/method on the org.acme.Foo class
• *.age - exlude the property/method age on any class

templatePathExclude

@ConfigItem(defaultValue="^\\..*|.*\\/\\..*$")
public Pattern templatePathExclude

This regular expression is used to exclude template files from the templates directory. Excluded templates are neither parsed nor validated during build and are not available at runtime.

The matched input is the file path relative from the templates directory and the / is used as a path separator.

By default, the hidden files are excluded. The name of a hidden file starts with a dot.

iterationMetadataPrefix

@ConfigItem(defaultValue="<alias_>")
public String iterationMetadataPrefix

The prefix is used to access the iteration metadata inside a loop section.

A valid prefix consists of alphanumeric characters and underscores. Three special constants can be used:

• <alias_> - the alias of an iterated element suffixed with an underscore is used, e.g. item_hasNext and it_count
• <alias?> - the alias of an iterated element suffixed with a question mark is used, e.g. item?hasNext and it?count
• <none> - no prefix is used, e.g. hasNext and count

By default, the <alias_> constant is set.

escapeContentTypes

@ConfigItem(defaultValue="text/html,text/xml,application/xml,application/xhtml+xml")
public List<String> escapeContentTypes

The list of content types for which the ', ", <, > and & characters are escaped if a template variant is set.

defaultCharset

@ConfigItem(defaultValue="UTF-8")
public Charset defaultCharset

The default charset of the templates files.

Constructor Detail

QuteConfig

public QuteConfig()