Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- AbstractJStachio - Class in io.jstach.jstachio.spi
-
An abstract jstachio that just needs a
JStachioExtensions
container. - AbstractJStachio() - Constructor for class io.jstach.jstachio.spi.AbstractJStachio
-
Do nothing constructor
- accept(byte[]) - Method in interface io.jstach.jstachio.output.OutputConsumer
-
Convenience method that will call the real accept.
- accept(byte[], int, int) - Method in interface io.jstach.jstachio.output.OutputConsumer
-
Analagous to
OutputStream.write(byte[], int, int)
. - accept(OutputConsumer<E>) - Method in interface io.jstach.jstachio.output.BufferedEncodedOutput
-
Transfers the entire buffered output to a consumer
- accept(OutputConsumer<E>) - Method in class io.jstach.jstachio.output.ByteBufferedOutputStream
- add(JStachioExtension) - Method in class io.jstach.jstachio.spi.JStachioFactory.Builder
-
Adds an extension
- add(TemplateInfo) - Method in class io.jstach.jstachio.spi.JStachioFactory.Builder
-
Registers an instantiated template.
- add(Iterable<? extends JStachioExtension>) - Method in class io.jstach.jstachio.spi.JStachioFactory.Builder
-
Add extensions.
- add(Collection<? extends TemplateInfo>) - Method in class io.jstach.jstachio.spi.JStachioFactory.Builder
-
Registers instantiated templates.
- addInterceptors(InterceptorRegistry) - Method in class io.jstach.opt.spring.boot.webmvc.JStachioWebMvcAutoConfiguration
- addInterceptors(InterceptorRegistry) - Method in class io.jstach.opt.spring.webmvc.ViewResolvingHandlerInterceptor
- addInterceptors(InterceptorRegistry) - Method in class io.jstach.opt.spring.webmvc.ViewSetupHandlerInterceptor
- App - Class in io.jstach.opt.spring.example
-
Entry point.
- App - Class in io.jstach.opt.spring.webflux.example
-
Entry point and class that defines shared jstachio config to be imported in other places with
JStacheConfig.using()
. - App() - Constructor for class io.jstach.opt.spring.example.App
-
To placate JDK 18 javadoc.
- App() - Constructor for class io.jstach.opt.spring.webflux.example.App
-
To placate JDK 18 javadoc.
- append(boolean) - Method in interface io.jstach.jstachio.Output
-
Write a long by using
String.valueOf(long)
. - append(boolean) - Method in class io.jstach.jstachio.output.ForwardingOutput
- append(boolean) - Method in class io.jstach.jstachio.Output.StringOutput
- append(char) - Method in interface io.jstach.jstachio.Output
-
Appends a character to an appendable.
- append(char) - Method in interface io.jstach.jstachio.Output.EncodedOutput
- append(char) - Method in class io.jstach.jstachio.output.ForwardingOutput
- append(char) - Method in class io.jstach.jstachio.Output.StringOutput
- append(double) - Method in interface io.jstach.jstachio.Output
-
Write a long by using
String.valueOf(long)
. - append(double) - Method in class io.jstach.jstachio.output.ForwardingOutput
- append(double) - Method in class io.jstach.jstachio.Output.StringOutput
- append(int) - Method in interface io.jstach.jstachio.Output
-
Write a int by using
String.valueOf(int)
. - append(int) - Method in class io.jstach.jstachio.output.ForwardingOutput
- append(int) - Method in class io.jstach.jstachio.Output.StringOutput
- append(long) - Method in interface io.jstach.jstachio.Output
-
Write a long by using
String.valueOf(long)
. - append(long) - Method in class io.jstach.jstachio.output.ForwardingOutput
- append(long) - Method in class io.jstach.jstachio.Output.StringOutput
- append(short) - Method in interface io.jstach.jstachio.Output
-
Write a short by using
String.valueOf(int)
- append(short) - Method in class io.jstach.jstachio.output.ForwardingOutput
- append(short) - Method in class io.jstach.jstachio.Output.StringOutput
- append(A, boolean) - Method in interface io.jstach.jstachio.Appender
-
Appends a boolean to the output.
- append(A, boolean) - Method in interface io.jstach.jstachio.Escaper
-
Escapes the character if it needs escaping.
- append(A, char) - Method in interface io.jstach.jstachio.Appender
-
Appends a character to the output.
- append(A, char) - Method in interface io.jstach.jstachio.Escaper
-
Escapes the character if it needs escaping.
- append(A, double) - Method in interface io.jstach.jstachio.Appender
-
Appends a double to the output.
- append(A, double) - Method in interface io.jstach.jstachio.Escaper
-
Escapes the character if it needs escaping.
- append(A, int) - Method in interface io.jstach.jstachio.Appender
-
Appends an int to the output.
- append(A, int) - Method in interface io.jstach.jstachio.Escaper
-
Escapes the character if it needs escaping.
- append(A, long) - Method in interface io.jstach.jstachio.Appender
-
Appends a long to the output.
- append(A, long) - Method in interface io.jstach.jstachio.Escaper
-
Escapes the character if it needs escaping.
- append(A, short) - Method in interface io.jstach.jstachio.Appender
-
Appends a short to the output.
- append(A, short) - Method in interface io.jstach.jstachio.Escaper
-
Escapes the character if it needs escaping.
- append(A, CharSequence) - Method in interface io.jstach.jstachio.Appender
-
Analogous to
Appendable.append(CharSequence)
. - append(A, CharSequence) - Method in interface io.jstach.jstachio.Escaper
-
Escapes the characters if it needs it.
- append(A, CharSequence, int, int) - Method in interface io.jstach.jstachio.Appender
-
Analogous to
Appendable.append(CharSequence, int, int)
. - append(A, CharSequence, int, int) - Method in interface io.jstach.jstachio.Escaper
-
Escapes the characters if it needs it.
- append(CharSequence) - Method in interface io.jstach.jstachio.Output
-
Analogous to
Appendable.append(CharSequence)
. - append(CharSequence) - Method in interface io.jstach.jstachio.output.BufferedEncodedOutput
- append(CharSequence) - Method in class io.jstach.jstachio.output.ForwardingOutput
- append(CharSequence) - Method in class io.jstach.jstachio.Output.StringOutput
- append(CharSequence) - Method in class io.jstach.jstachio.output.ThresholdEncodedOutput
- append(CharSequence, int, int) - Method in interface io.jstach.jstachio.Output
-
Analogous to
Appendable.append(CharSequence, int, int)
. - append(CharSequence, int, int) - Method in interface io.jstach.jstachio.Output.EncodedOutput
- append(CharSequence, int, int) - Method in class io.jstach.jstachio.output.ForwardingOutput
- append(CharSequence, int, int) - Method in class io.jstach.jstachio.Output.StringOutput
- append(String) - Method in interface io.jstach.jstachio.Output
-
Analogous to
Appendable.append(CharSequence)
which by default treats the String as a CharSequence. - append(String) - Method in interface io.jstach.jstachio.output.BufferedEncodedOutput
- append(String) - Method in class io.jstach.jstachio.output.ByteBufferedOutputStream
- append(String) - Method in interface io.jstach.jstachio.Output.EncodedOutput
- append(String) - Method in class io.jstach.jstachio.output.ForwardingOutput
- append(String) - Method in class io.jstach.jstachio.Output.StringOutput
- append(String) - Method in class io.jstach.jstachio.output.ThresholdEncodedOutput
- Appender - Interface in io.jstach.jstachio
-
A singleton like decorator for appendables that has additional methods for dealing with native types used to output variables that have been formatted.
- apply(Object) - Method in interface io.jstach.jstachio.Formatter
-
Formats an object by using
StringBuilder
and callingFormatter.format(Appender, Output, String, Class, Object)
. - apply(String) - Method in interface io.jstach.jstachio.Escaper
-
Escapes a String by using StringBuilder and calling
Escaper.append(Output, CharSequence)
. - asByteBuffer() - Method in class io.jstach.jstachio.output.ByteBufferedOutputStream
- asByteBuffer() - Method in interface io.jstach.jstachio.output.ByteBufferEncodedOutput
-
Gets a byte buffer view of the data.
- asReadableByteChannel() - Method in interface io.jstach.jstachio.output.BufferedEncodedOutput
-
Represents the encoded output as readable channel.
- asReadableByteChannel() - Method in interface io.jstach.jstachio.output.ByteBufferEncodedOutput
- AUTO_SUFFIX - Static variable in annotation interface io.jstach.jstache.JStachePath
-
If a JStache path is empty and template is empty and suffix is unspecified the path will be generated from the class name and suffixed with this constant.
B
- buf - Variable in class io.jstach.jstachio.output.ByteBufferedOutputStream
-
The buffer where data is stored.
- BUFFER_SIZE - Static variable in class io.jstach.jstachio.output.ByteBufferedOutputStream
-
Default buffer size:
4k
. - BufferedEncodedOutput - Interface in io.jstach.jstachio.output
-
An encoded output that will store the output in its preferred memory structure and can then be copied to an
OutputStream
or read from aReadableByteChannel
. - bufferLimit - Variable in class io.jstach.opt.spring.web.JStachioHttpMessageConverter
-
The maximum amount of bytes to buffer.
- bufferSize() - Method in interface io.jstach.opt.spring.webflux.JStachioModelView
-
The initial size of the buffer allocated to be used for rendering.
- bufferSizeHint() - Method in interface io.jstach.jstachio.output.BufferedEncodedOutput
-
The recommend buffer size to use for extracting with
BufferedEncodedOutput.asReadableByteChannel()
orBufferedEncodedOutput.transferTo(OutputStream)
. - bufferSizeHint() - Method in interface io.jstach.jstachio.output.ChunkEncodedOutput
-
For chunk output the buffer hint is usually the size of the largest chunk.
- build() - Method in class io.jstach.jstachio.spi.JStachioFactory.Builder
-
Builds a JStachio by coalescing the extensions and registered templates.
- builder() - Static method in class io.jstach.jstachio.spi.JStachioFactory
-
A mutable builder to create
JStachio
fromJStachioExtension
s. - ByteBufferedOutputStream - Class in io.jstach.jstachio.output
-
A custom OutputStream that is designed for generating bytes from pre-encoded output as well as reused carefully either by threadlocals or some other pooling mechanism.
- ByteBufferedOutputStream() - Constructor for class io.jstach.jstachio.output.ByteBufferedOutputStream
-
Creates buffered stream of buffer initial size: 4096.
- ByteBufferedOutputStream(int) - Constructor for class io.jstach.jstachio.output.ByteBufferedOutputStream
-
Creates buffered stream of given size.
- ByteBufferedOutputStream(int, Charset) - Constructor for class io.jstach.jstachio.output.ByteBufferedOutputStream
-
Creates buffered Output of given size and given charset if used as a Jstachio Output.
- ByteBufferEncodedOutput - Interface in io.jstach.jstachio.output
-
An encoded output optimized for producing a single
ByteBuffer
.
C
- cachedTemplateFinder(JStachioTemplateFinder) - Static method in interface io.jstach.jstachio.spi.JStachioTemplateFinder
-
Decorates a template finder with a cache using
ClassValue
with the modelType as the key. - canEncode(ResolvableType, MimeType) - Method in class io.jstach.opt.spring.webflux.JStachioEncoder
- canRead(Class<?>, MediaType) - Method in class io.jstach.opt.spring.web.JStachioHttpMessageConverter
- charset - Variable in class io.jstach.jstachio.output.ByteBufferedOutputStream
-
The expected charset of the output.
- charset() - Element in annotation interface io.jstach.jstache.JStacheConfig
-
Encoding of template files.
- charset() - Method in class io.jstach.jstachio.output.ByteBufferedOutputStream
- charset() - Method in interface io.jstach.jstachio.Output.EncodedOutput
-
The charset that the encoded output should be.
- charset() - Method in class io.jstach.jstachio.output.ForwardingEncodedOutput
- charset() - Method in class io.jstach.jstachio.output.ThresholdEncodedOutput
- charset() - Method in interface io.jstach.opt.dropwizard.JStachioView
-
The charset never null
- charsets() - Element in annotation interface io.jstach.jstache.JStacheContentType
-
The charsets supported by the escaper.
- ChunkEncodedOutput<T> - Interface in io.jstach.jstachio.output
-
Maintains the encoded output in an iterable of chunks of type
T
that is optimized forBufferedEncodedOutput.asReadableByteChannel()
. - close() - Method in interface io.jstach.jstachio.output.BufferedEncodedOutput
-
Signals that the buffer should be reset for reuse or destroyed.
- close() - Method in class io.jstach.jstachio.output.ByteBufferedOutputStream
- close() - Method in interface io.jstach.jstachio.Output.CloseableEncodedOutput
- close() - Method in interface io.jstach.jstachio.output.OutputConsumer
- close() - Method in class io.jstach.jstachio.output.ThresholdEncodedOutput
-
If the limit is not exceeded then the buffered data will be replayed and pushed when closed.
- close(OutputStream) - Method in class io.jstach.jstachio.output.ThresholdEncodedOutput.OutputStreamThresholdEncodedOutput
- close(T) - Method in class io.jstach.jstachio.output.ThresholdEncodedOutput
-
Called to close the consumer.
- compose(Iterable<JStachioFilter>) - Static method in interface io.jstach.jstachio.spi.JStachioFilter
-
Creates a composite filter of a many filters.
- config(Environment) - Method in class io.jstach.opt.spring.boot.webmvc.JStachioConfiguration
-
Resolve config from spring environment
- config(PropertyResolver) - Static method in class io.jstach.opt.spring.SpringJStachioExtension
-
Creates a JStachio config from a property resolver (usually
Environment
). - configure(Object, Map<String, ?>, HttpServletRequest) - Method in interface io.jstach.opt.spring.webmvc.JStachioModelViewConfigurer
-
Configures a JStache model with the current request and traditional Spring model before being rendered.
- configure(Object, Map<String, Object>, ServerWebExchange) - Method in interface io.jstach.opt.spring.webflux.JStachioModelViewConfigurer
-
Configures a JStache model with the current request and traditional Spring model before being rendered.
- configure(Map<String, String>) - Method in class io.jstach.opt.dropwizard.JStachioViewRenderer
- configureHttpMessageCodecs(ServerCodecConfigurer) - Method in class io.jstach.opt.spring.webflux.example.WebConfig
- configureMessageConverters(List<HttpMessageConverter<?>>) - Method in class io.jstach.opt.spring.boot.webmvc.JStachioWebMvcAutoConfiguration
- configurer() - Method in class io.jstach.opt.spring.example.message.MessageConfiguration
-
Bean to create configurer bean that does cross cutting logic across controllers
- configurer() - Method in class io.jstach.opt.spring.webflux.example.message.MessageConfiguration
-
Creates the configurer for Spring
- CONSTRUCTOR - Enum constant in enum class io.jstach.jstachio.spi.Templates.TemplateLoadStrategy
-
Strategy that will try no-arg constructor
- consumer() - Method in interface io.jstach.jstachio.output.LimitEncodedOutput
-
The created consumer.
- consumer() - Method in class io.jstach.jstachio.output.ThresholdEncodedOutput
- contentType() - Element in annotation interface io.jstach.jstache.JStacheConfig
-
Optional content type which determines what escaper to use for all models in the annotated class/package/module.
- context() - Method in interface io.jstach.jstachio.context.ContextSupplier
-
A context node never null but maybe empty.
- context(Map<String, Object>) - Method in class io.jstach.opt.spring.example.hello.HelloController
-
Here we show MVC model support which will be bound to "@context".
- CONTEXT_BINDING_NAME - Static variable in interface io.jstach.jstachio.context.ContextNode
-
The default binding name in mustache for the context parameter.
- CONTEXT_SUPPORT_DISABLE - Enum constant in enum class io.jstach.jstache.JStacheFlags.Flag
-
Will always bind "@context" with a empty ContextNode.
- ContextJStachio - Interface in io.jstach.jstachio.context
-
A special JStachio that can render models with a loose typed context object bound to "@context".
- ContextNode - Interface in io.jstach.jstachio.context
-
This interface serves three puproses: A way to represent the current context stack (see
ContextNode.parent()
) Allow you to simulate JSON/Javscript object node like trees without being coupled to a particularly JSON lib. - ContextSupplier - Interface in io.jstach.jstachio.context
-
A marker interface to signify something is context aware.
- ContextTemplate<T> - Interface in io.jstach.jstachio.context
-
A context aware template.
- count - Variable in class io.jstach.jstachio.output.ByteBufferedOutputStream
-
The number of valid bytes in the buffer.
- create(int) - Method in interface io.jstach.jstachio.output.OutputFactory
-
Create the output type
- createConsumer(int) - Method in class io.jstach.jstachio.output.ThresholdEncodedOutput
-
Creates the consumer.
- createOutput(HttpServletResponse) - Method in class io.jstach.opt.spring.webmvc.ServletJStachioHttpMessageConverter
-
Create the output from a servlet response.
- createOutput(Charset, HttpServletResponse) - Method in interface io.jstach.opt.spring.webmvc.JStachioModelView
-
Creates the output from the servlet response to use for rendering.
- createOutput(HttpOutputMessage) - Method in class io.jstach.opt.spring.web.JStachioHttpMessageConverter
-
Create the buffered output to use when executing JStachio.
- createOutput(HttpOutputMessage) - Method in class io.jstach.opt.spring.webmvc.ServletJStachioHttpMessageConverter
D
- DEBUG - Enum constant in enum class io.jstach.jstache.JStacheFlags.Flag
-
This will produce additional logging that is sent to standard out while the annotation processor runs (not during runtime).
- DEFAULT_BUFFER_LIMIT - Static variable in class io.jstach.opt.spring.web.JStachioHttpMessageConverter
-
The default buffer limit before bailing on trying to set
Content-Length
. - DEFAULT_BUFFER_LIMIT - Static variable in interface io.jstach.opt.spring.webmvc.JStachioModelView
-
The default buffer limit before bailing on trying to set
Content-Length
. - DEFAULT_MEDIA_TYPE - Static variable in class io.jstach.opt.spring.web.JStachioHttpMessageConverter
-
The default media type is "
text/html; charset=UTF-8
". - DEFAULT_MEDIA_TYPE - Static variable in interface io.jstach.opt.spring.webmvc.JStachioModelView
-
The default media type is "
text/html; charset=UTF-8
". - DEFAULT_PREFIX - Static variable in annotation interface io.jstach.jstache.JStacheName
-
The default prefix if no
JStacheName.prefix()
is set anywhere. - DEFAULT_PREFIX - Static variable in annotation interface io.jstach.jstache.JStachePath
-
The default prefix if
JStachePath.UNSPECIFIED
. - DEFAULT_SUFFIX - Static variable in annotation interface io.jstach.jstache.JStacheName
-
The default suffix if no
JStacheName.suffix()
is set anywhere. - DEFAULT_SUFFIX - Static variable in annotation interface io.jstach.jstache.JStachePath
-
The default suffix if
JStachePath.UNSPECIFIED
. - defaultAppender() - Static method in interface io.jstach.jstachio.Appender
-
Default appender simply passes the contents unchanged to the Appendable.
- DefaultFormatter - Interface in io.jstach.jstachio.formatters
-
Default formatters.
- defaultJStachio() - Static method in class io.jstach.jstachio.spi.JStachioFactory
-
Provides a singleton JStachio resolved by the
ServiceLoader
. - DefaultJStachioView - Class in io.jstach.opt.dropwizard
-
Default view implementation.
- DefaultJStachioView(Object) - Constructor for class io.jstach.opt.dropwizard.DefaultJStachioView
-
Creates a view from the given model
- defaults() - Static method in interface io.jstach.jstachio.JStachio
-
Gets default singleton ServiceLoader based jstachio.
- defaultTemplateFinder(JStachioConfig) - Static method in interface io.jstach.jstachio.spi.JStachioTemplateFinder
-
The default template finder that uses reflection and or the ServiceLoader.
- delegate() - Method in class io.jstach.jstachio.output.ForwardingEncodedOutput
- delegate() - Method in class io.jstach.jstachio.output.ForwardingOutput
-
The output to forward to.
- description() - Method in interface io.jstach.jstachio.TemplateInfo
-
Utility method similar to toString that describes the template meta data.
- DropwizardJStacheConfig - Enum Class in io.jstach.opt.dropwizard
-
Opinionated static config for dropwizard based on how dropwizard stores templates for Mustache.java.
E
- empty() - Static method in interface io.jstach.jstachio.context.ContextNode
-
An empty context node that is safe to use identify comparison.
- empty() - Static method in interface io.jstach.jstachio.TemplateConfig
-
A config with no provided collaborators.
- encode(ExampleModel, A, Formatter, Escaper, Appender) - Static method in class io.jstach.opt.dropwizard.example.ExampleModelRenderer
-
Renders to an OutputStream use pre-encoded parts of the template.
- encode(ExampleModelRenderer, ExampleModel, ContextNode, A, Formatter, Escaper, Appender) - Static method in class io.jstach.opt.dropwizard.example.ExampleModelRenderer
-
Renders to an OutputStream use pre-encoded parts of the template.
- encode(HelloModelAndView, A, Formatter, Escaper, Appender) - Static method in class io.jstach.opt.spring.example.hello.HelloModelAndViewView
-
Renders to an OutputStream use pre-encoded parts of the template.
- encode(HelloModelAndViewView, HelloModelAndView, ContextNode, A, Formatter, Escaper, Appender) - Static method in class io.jstach.opt.spring.example.hello.HelloModelAndViewView
-
Renders to an OutputStream use pre-encoded parts of the template.
- encode(HelloModel, A, Formatter, Escaper, Appender) - Static method in class io.jstach.opt.spring.example.hello.HelloModelView
-
Renders to an OutputStream use pre-encoded parts of the template.
- encode(HelloModelView, HelloModel, ContextNode, A, Formatter, Escaper, Appender) - Static method in class io.jstach.opt.spring.example.hello.HelloModelView
-
Renders to an OutputStream use pre-encoded parts of the template.
- encode(MessagePage, A, Formatter, Escaper, Appender) - Static method in class io.jstach.opt.spring.example.message.MessagePageRenderer
-
Renders to an OutputStream use pre-encoded parts of the template.
- encode(MessagePageRenderer, MessagePage, ContextNode, A, Formatter, Escaper, Appender) - Static method in class io.jstach.opt.spring.example.message.MessagePageRenderer
-
Renders to an OutputStream use pre-encoded parts of the template.
- encode(HelloModel, A, Formatter, Escaper, Appender) - Static method in class io.jstach.opt.spring.webflux.example.hello.HelloModelView
-
Renders to an OutputStream use pre-encoded parts of the template.
- encode(HelloModelView, HelloModel, ContextNode, A, Formatter, Escaper, Appender) - Static method in class io.jstach.opt.spring.webflux.example.hello.HelloModelView
-
Renders to an OutputStream use pre-encoded parts of the template.
- encode(MessagePage, A, Formatter, Escaper, Appender) - Static method in class io.jstach.opt.spring.webflux.example.message.MessagePageRenderer
-
Renders to an OutputStream use pre-encoded parts of the template.
- encode(MessagePageRenderer, MessagePage, ContextNode, A, Formatter, Escaper, Appender) - Static method in class io.jstach.opt.spring.webflux.example.message.MessagePageRenderer
-
Renders to an OutputStream use pre-encoded parts of the template.
- encode(Object, DataBufferFactory, ResolvableType, MimeType, Map<String, Object>) - Method in class io.jstach.opt.spring.webflux.JStachioEncoder
- encodeValue(Object, DataBufferFactory, ResolvableType, MimeType, Map<String, Object>) - Method in class io.jstach.opt.spring.webflux.JStachioEncoder
- entity() - Method in class io.jstach.opt.spring.example.hello.HelloController
-
Here we use a
ResponseEntity
which allows use to set status codes with our model to be rendered. - equals(Object) - Method in record class io.jstach.opt.dropwizard.example.ExampleModel
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.jstach.opt.spring.example.hello.HelloModel
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.jstach.opt.spring.example.hello.HelloModelAndView
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.jstach.opt.spring.webflux.example.hello.HelloModel
-
Indicates whether some other object is "equal to" this one.
- escaper() - Method in interface io.jstach.jstachio.TemplateConfig
-
The escaper to be used on the template.
- Escaper - Interface in io.jstach.jstachio
-
An Escaper is an
Appender
used to escape content such as HTML. - ExampleApplicationStart - Class in io.jstach.opt.dropwizard.example
-
Dropwizard example application entry point.
- ExampleApplicationStart() - Constructor for class io.jstach.opt.dropwizard.example.ExampleApplicationStart
- ExampleConfiguration - Class in io.jstach.opt.dropwizard.example
-
Since JStachio is mostly static configuration this class is empty.
- ExampleConfiguration() - Constructor for class io.jstach.opt.dropwizard.example.ExampleConfiguration
- ExampleModel - Record Class in io.jstach.opt.dropwizard.example
-
A JStache model using external template:
src/main/resources/io/jstach/opt/dropwizard/example/ExampleModel.mustache
. - ExampleModel(String) - Constructor for record class io.jstach.opt.dropwizard.example.ExampleModel
-
Creates an instance of a
ExampleModel
record class. - ExampleModelRenderer - Class in io.jstach.opt.dropwizard.example
-
Generated Renderer.
- ExampleModelRenderer() - Constructor for class io.jstach.opt.dropwizard.example.ExampleModelRenderer
-
Renderer constructor for reflection (use of() instead).
- ExampleModelRenderer(TemplateConfig) - Constructor for class io.jstach.opt.dropwizard.example.ExampleModelRenderer
-
Renderer constructor using config.
- ExampleModelRenderer(Function<Object, String>, Function<String, String>) - Constructor for class io.jstach.opt.dropwizard.example.ExampleModelRenderer
-
Renderer constructor for manual wiring.
- ExampleResource - Class in io.jstach.opt.dropwizard.example
-
Dropwizard JAXRS example resource highlighting JStachio integration.
- ExampleResource() - Constructor for class io.jstach.opt.dropwizard.example.ExampleResource
- execute() - Method in interface io.jstach.jstachio.TemplateModel
-
Renders the template to a String.
- execute(A) - Method in interface io.jstach.jstachio.TemplateModel
-
Renders the passed in model directly to an appendable like output.
- execute(ExampleModel, A) - Method in class io.jstach.opt.dropwizard.example.ExampleModelRenderer
- execute(ExampleModel, A, Formatter, Escaper) - Method in class io.jstach.opt.dropwizard.example.ExampleModelRenderer
-
Renders the passed in model.
- execute(ExampleModel, ContextNode, A) - Method in class io.jstach.opt.dropwizard.example.ExampleModelRenderer
- execute(ExampleModel, StringBuilder) - Method in class io.jstach.opt.dropwizard.example.ExampleModelRenderer
- execute(HelloModelAndView, A) - Method in class io.jstach.opt.spring.example.hello.HelloModelAndViewView
- execute(HelloModelAndView, A, Formatter, Escaper) - Method in class io.jstach.opt.spring.example.hello.HelloModelAndViewView
-
Renders the passed in model.
- execute(HelloModelAndView, ContextNode, A) - Method in class io.jstach.opt.spring.example.hello.HelloModelAndViewView
- execute(HelloModelAndView, StringBuilder) - Method in class io.jstach.opt.spring.example.hello.HelloModelAndViewView
- execute(HelloModel, A) - Method in class io.jstach.opt.spring.example.hello.HelloModelView
- execute(HelloModel, A, Formatter, Escaper) - Method in class io.jstach.opt.spring.example.hello.HelloModelView
-
Renders the passed in model.
- execute(HelloModel, ContextNode, A) - Method in class io.jstach.opt.spring.example.hello.HelloModelView
- execute(HelloModel, StringBuilder) - Method in class io.jstach.opt.spring.example.hello.HelloModelView
- execute(MessagePage, A) - Method in class io.jstach.opt.spring.example.message.MessagePageRenderer
- execute(MessagePage, A, Formatter, Escaper) - Method in class io.jstach.opt.spring.example.message.MessagePageRenderer
-
Renders the passed in model.
- execute(MessagePage, ContextNode, A) - Method in class io.jstach.opt.spring.example.message.MessagePageRenderer
- execute(MessagePage, StringBuilder) - Method in class io.jstach.opt.spring.example.message.MessagePageRenderer
- execute(HelloModel, A) - Method in class io.jstach.opt.spring.webflux.example.hello.HelloModelView
- execute(HelloModel, A, Formatter, Escaper) - Method in class io.jstach.opt.spring.webflux.example.hello.HelloModelView
-
Renders the passed in model.
- execute(HelloModel, ContextNode, A) - Method in class io.jstach.opt.spring.webflux.example.hello.HelloModelView
- execute(HelloModel, StringBuilder) - Method in class io.jstach.opt.spring.webflux.example.hello.HelloModelView
- execute(MessagePage, A) - Method in class io.jstach.opt.spring.webflux.example.message.MessagePageRenderer
- execute(MessagePage, A, Formatter, Escaper) - Method in class io.jstach.opt.spring.webflux.example.message.MessagePageRenderer
-
Renders the passed in model.
- execute(MessagePage, ContextNode, A) - Method in class io.jstach.opt.spring.webflux.example.message.MessagePageRenderer
- execute(MessagePage, StringBuilder) - Method in class io.jstach.opt.spring.webflux.example.message.MessagePageRenderer
- execute(Object) - Method in interface io.jstach.jstachio.JStachio
-
Finds a template by using the models class if possible and then applies filtering and then finally render the model to a String.
- execute(Object, A) - Method in class io.jstach.jstachio.spi.AbstractJStachio
- execute(Object, ContextNode, A) - Method in interface io.jstach.jstachio.context.ContextJStachio
-
Renders the passed in model with a context.
- execute(Object, ContextNode, A) - Method in class io.jstach.jstachio.spi.AbstractJStachio
- execute(Object, Appendable) - Method in interface io.jstach.jstachio.JStachio
-
Finds a template by using the models class if possible and then applies filtering and then finally render the model by writing to the appendable.
- execute(Object, Appendable, TemplateInfo, boolean) - Method in class io.jstach.opt.jmustache.JMustacheRenderer
-
Deprecated.
- execute(Object, StringBuilder) - Method in interface io.jstach.jstachio.JStachio
-
Finds a template by using the models class if possible and then applies filtering and then finally render the model by writing to the
StringBuilder
. - execute(T) - Method in interface io.jstach.jstachio.Renderer
-
Convenience method that directly renders the model as a String.
- execute(T, A) - Method in interface io.jstach.jstachio.Renderer
-
Renders the passed in model.
- execute(T, A) - Method in interface io.jstach.jstachio.Template
-
Renders the passed in model to an appendable like output.
- execute(T, ContextNode, A) - Method in interface io.jstach.jstachio.context.ContextTemplate
-
Renders the passed in model to an appendable like output.
- execute(T, Appendable) - Method in interface io.jstach.jstachio.Renderer
-
Renders the passed in model.
- execute(T, StringBuilder) - Method in interface io.jstach.jstachio.Renderer
-
A convenience method that does not throw
IOException
when using StringBuilder. - extensions() - Method in interface io.jstach.jstachio.spi.JStachioExtensions.Provider
-
The available extensions.
- extensions() - Method in class io.jstach.opt.spring.SpringJStachio
F
- filter(TemplateInfo, JStachioFilter.FilterChain) - Method in interface io.jstach.jstachio.spi.JStachioFilter
-
Advises or filters a previously created filter.
- filter(TemplateInfo, JStachioFilter.FilterChain) - Method in class io.jstach.opt.jmustache.JMustacheRenderer
- find(String) - Method in interface io.jstach.jstachio.context.ContextNode
-
Will search up the tree for a field starting at this nodes children first.
- find(String) - Method in class io.jstach.jstachio.context.ObjectContext
- findExtension(Class<T>) - Method in interface io.jstach.jstachio.spi.JStachioExtensions
-
Finds a specific implementation using
Class.isAssignableFrom(Class)
. - findOrNull(Class<?>) - Method in interface io.jstach.jstachio.spi.JStachioTemplateFinder
-
Finds a template or null if no template is found.
- findOrNull(Class<?>) - Method in interface io.jstach.jstachio.spi.JStachioTemplateFinder.SimpleTemplateFinder
- findTemplate(Class<?>) - Method in interface io.jstach.jstachio.spi.JStachioTemplateFinder
-
Finds a
Template
if possible otherwise possibly falling back to aTemplateInfo
based on annotation metadata or some other mechanism. - findTemplate(Class<?>) - Method in interface io.jstach.jstachio.spi.JStachioTemplateFinder.SimpleTemplateFinder
- findTemplate(Class<?>, JStachioConfig) - Static method in class io.jstach.jstachio.spi.Templates
-
Finds a
Template
if possible otherwise falling back to aTemplateInfo
based on annotation metadata. - findTemplate(Object) - Method in interface io.jstach.jstachio.JStachio
-
Finds a template by model.
- findTemplate(Object) - Method in class io.jstach.jstachio.spi.AbstractJStachio
- findTemplateOrNull(Class<?>, JStachioConfig) - Static method in class io.jstach.jstachio.spi.Templates
-
Finds a
Template
if possible otherwise falling back to aTemplateInfo
based on annotation metadata. - findTemplates(ServiceLoader<TemplateProvider>, TemplateConfig, Consumer<ServiceConfigurationError>) - Static method in class io.jstach.jstachio.spi.Templates
-
Find templates by the given service loader.
- FIRST_BINDING_NAME - Static variable in annotation interface io.jstach.jstache.JStache
-
A handlebars inspired virtual variable that is bound while in list contexts.
- FIRST_JMUSTACHE_BINDING_NAME - Static variable in annotation interface io.jstach.jstache.JStache
-
A JMustache inspired virtual variable that is bound while in list contexts.
- flags() - Element in annotation interface io.jstach.jstache.JStacheCatalog
-
Configuration flags for generating template catalogs.
- flags() - Element in annotation interface io.jstach.jstache.JStacheFlags
-
Compiler flags that will be used on for this model.
- format(Appender, A, String, boolean) - Method in interface io.jstach.jstachio.Formatter
-
Formats the object and then sends the results to the downstream appender.
- format(Appender, A, String, char) - Method in interface io.jstach.jstachio.Formatter
-
Formats the object and then sends the results to the downstream appender.
- format(Appender, A, String, double) - Method in interface io.jstach.jstachio.Formatter
-
Formats the object and then sends the results to the downstream appender.
- format(Appender, A, String, int) - Method in interface io.jstach.jstachio.Formatter
-
Formats the object and then sends the results to the downstream appender.
- format(Appender, A, String, long) - Method in interface io.jstach.jstachio.Formatter
-
Formats the object and then sends the results to the downstream appender.
- format(Appender, A, String, short) - Method in interface io.jstach.jstachio.Formatter
-
Formats the object and then sends the results to the downstream appender.
- format(Appender, A, String, Formatter.Formattable) - Method in interface io.jstach.jstachio.Formatter
-
Formats the formattable object and then sends the results to the downstream appender.
- format(Appender, A, String, String) - Method in interface io.jstach.jstachio.Formatter
-
Formats the object and then sends the results to the downstream appender.
- format(Appender, A, String, String) - Method in interface io.jstach.jstachio.formatters.DefaultFormatter
-
Formats the object and then sends the results to the downstream appender.
- format(Appender, A, String, String) - Method in interface io.jstach.jstachio.formatters.SpecFormatter
-
Formats the object and then sends the results to the downstream appender.
- format(Appender, A, String, Class<?>, Object) - Method in interface io.jstach.jstachio.Formatter
-
Formats the object and then sends the results to the downstream appender.
- format(Appender, A, String, Class<?>, Object) - Method in interface io.jstach.jstachio.formatters.DefaultFormatter
-
Formats the object and then sends the results to the downstream appender.
- format(Appender, A, String, Class<?>, Object) - Method in interface io.jstach.jstachio.formatters.SpecFormatter
-
Formats the object and then sends the results to the downstream appender.
- format(Formatter, Appender, String, A) - Method in interface io.jstach.jstachio.Formatter.Formattable
-
Called by the formatter to format.
- formatter() - Element in annotation interface io.jstach.jstache.JStacheConfig
-
Optional formatter if not UNSPECIFIED for all models in the annotated class/package/module .
- formatter() - Method in interface io.jstach.jstachio.TemplateConfig
-
The base formatter to be used on the template.
- Formatter - Interface in io.jstach.jstachio
-
Formats and then sends the results to the downstream appender.
- Formatter.Formattable - Interface in io.jstach.jstachio
-
Implement to allow formatting of custom objects you want to output.
- ForwardingEncodedOutput<E extends Exception> - Class in io.jstach.jstachio.output
-
An encoded output that forwards all calls to a delegate.
- ForwardingEncodedOutput() - Constructor for class io.jstach.jstachio.output.ForwardingEncodedOutput
- ForwardingOutput<E extends Exception> - Class in io.jstach.jstachio.output
-
An encoded output that forwards all calls to a delegate.
- ForwardingOutput() - Constructor for class io.jstach.jstachio.output.ForwardingOutput
G
- GENERATE_FINDER_META_INF_SERVICE - Enum constant in enum class io.jstach.jstache.JStacheCatalog.CatalogFlag
-
Option that will generate a legacy service loader registration:
META-INF/services/io.jstach.jstachio.spi.JStachioTemplateFinder
pointing to the generated template catalog. - GENERATE_PROVIDER_META_INF_SERVICE - Enum constant in enum class io.jstach.jstache.JStacheCatalog.CatalogFlag
-
Option that will generate a legacy service loader registration:
META-INF/services/io.jstach.jstachio.spi.TemplateProvider
pointing to the generated template catalog. - generatedClassName(Class<?>) - Static method in class io.jstach.jstachio.spi.Templates
-
Gets the canonical class name of the generated template code regardless of whether or not code has actually been generated.
- get(String) - Method in interface io.jstach.jstachio.context.ContextNode
-
Gets a field from a ContextNode.
- get(String) - Method in class io.jstach.jstachio.context.ObjectContext
- getBoolean(String) - Method in interface io.jstach.jstachio.spi.JStachioConfig
- getBoolean(String, boolean) - Method in interface io.jstach.jstachio.spi.JStachioConfig
-
Gets the property as a boolean and if no property value is found the fallback is used.
- getBuffer() - Method in class io.jstach.jstachio.Output.StringOutput
-
The buffer that has been wrapped.
- getBufferLimit() - Method in class io.jstach.opt.spring.boot.webmvc.JStachioProperties
-
Because JStachio does pre-encoding of templates it can handle buffering the template output better than the builtin servlet framework buffering while reliable setting the
Content-Length
. - getChunks() - Method in interface io.jstach.jstachio.output.ChunkEncodedOutput
-
Gets the internal sequence of chunks.
- getConfig() - Method in interface io.jstach.jstachio.spi.JStachioExtensions
-
Composite Config where the first config that returns a nonnull for
JStachioConfig.getProperty(String)
is used. - getConfigurationKey() - Method in class io.jstach.opt.dropwizard.JStachioViewRenderer
- getContentType() - Method in interface io.jstach.opt.spring.webmvc.JStachioModelView
- getExtensions() - Method in interface io.jstach.jstachio.spi.JStachioExtensions
-
The orignal contained extensions excluding the composites.
- getFilter() - Method in interface io.jstach.jstachio.spi.JStachioExtensions
-
Composite Filter where the ordering of the filter is based on a combination of
JStachioFilter.order()
first and then the order in the iterable passed toJStachioExtensions.of(Iterable)
. - getInfoByReflection(Class<?>) - Static method in class io.jstach.jstachio.spi.Templates
-
Finds template info by accessing JStache annotations through reflective lookup.
- getLogger(String) - Method in interface io.jstach.jstachio.spi.JStachioConfig
-
Gets a system logger if the property
JStachioConfig.LOGGING_DISABLE
isfalse
. - getMediaType() - Method in class io.jstach.opt.spring.boot.webmvc.JStachioProperties
-
The media type which by default is "
text/html; charset=UTF-8
". - getMediaType() - Method in interface io.jstach.opt.spring.webmvc.JStachioModelView
-
The media type for this view.
- getPathInfo(Class<?>) - Static method in class io.jstach.jstachio.spi.Templates
-
INTERNAL (use at your own risk): Resolved
JStachePath
config by replacingJStachePath.UNSPECIFIED
with default values. - getProperty(String) - Method in interface io.jstach.jstachio.spi.JStachioConfig
-
Gets a property from some config implementation.
- getSupportedMediaTypes() - Method in interface io.jstach.opt.spring.webflux.JStachioModelView
- getTemplate(Class<T>) - Static method in class io.jstach.jstachio.spi.Templates
-
Finds a template by reflection or an exception is thrown.
- getTemplate(Class<T>, Iterable<Templates.TemplateLoadStrategy>, Iterable<ClassLoader>, System.Logger) - Static method in class io.jstach.jstachio.spi.Templates
-
Finds a template by reflection or an exception is thrown.
- getTemplateFinder() - Method in interface io.jstach.jstachio.spi.JStachioExtensions
-
Composite Template finder where the first template finder that finds a template is used.
- getValue(String) - Method in class io.jstach.jstachio.context.ObjectContext
-
Get a value by key.
H
- hashCode() - Method in record class io.jstach.opt.dropwizard.example.ExampleModel
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.jstach.opt.spring.example.hello.HelloModel
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.jstach.opt.spring.example.hello.HelloModelAndView
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.jstach.opt.spring.webflux.example.hello.HelloModel
-
Returns a hash code value for this object.
- hello() - Method in class io.jstach.opt.dropwizard.example.ExampleResource
-
For this endpoint we create the model and call the model to view mixin
JStacheViewSupport.toView()
. - hello() - Method in class io.jstach.opt.spring.example.hello.HelloController
-
Here we use JStachio runtime to resolve the renderer (in this case we are calling them Views) via Springs Http Message Converter.
- hello() - Method in class io.jstach.opt.spring.webflux.example.hello.HelloController
-
Here we use JStachio runtime to resolve the renderer (in this case we are calling them Views) via Springs Http Message Converter.
- HelloController - Class in io.jstach.opt.spring.example.hello
-
Example hello world controller using different ways to use JStachio for web development.
- HelloController - Class in io.jstach.opt.spring.webflux.example.hello
-
Example hello world controller using different ways to use JStachio for web development.
- HelloController() - Constructor for class io.jstach.opt.spring.webflux.example.hello.HelloController
-
Placate JDK 18 Javadoc
- HelloController(JStachio, Template<HelloModel>) - Constructor for class io.jstach.opt.spring.example.hello.HelloController
-
Placate JDK 18 Javadoc
- HelloModel - Record Class in io.jstach.opt.spring.example.hello
-
Model using a resource template that is in src/main/resources/views.
- HelloModel - Record Class in io.jstach.opt.spring.webflux.example.hello
-
Model using a resource template that is in src/main/resources/views.
- HelloModel(String) - Constructor for record class io.jstach.opt.spring.example.hello.HelloModel
-
Creates an instance of a
HelloModel
record class. - HelloModel(String) - Constructor for record class io.jstach.opt.spring.webflux.example.hello.HelloModel
-
Creates an instance of a
HelloModel
record class. - HelloModelAndView - Record Class in io.jstach.opt.spring.example.hello
-
Model that implements
JStachioModelView
using a resource template that is in src/main/resources/views. - HelloModelAndView(String) - Constructor for record class io.jstach.opt.spring.example.hello.HelloModelAndView
-
Creates an instance of a
HelloModelAndView
record class. - HelloModelAndViewView - Class in io.jstach.opt.spring.example.hello
-
Generated Renderer.
- HelloModelAndViewView() - Constructor for class io.jstach.opt.spring.example.hello.HelloModelAndViewView
-
Renderer constructor for reflection (use of() instead).
- HelloModelAndViewView(TemplateConfig) - Constructor for class io.jstach.opt.spring.example.hello.HelloModelAndViewView
-
Renderer constructor using config.
- HelloModelAndViewView(Function<Object, String>, Function<String, String>) - Constructor for class io.jstach.opt.spring.example.hello.HelloModelAndViewView
-
Renderer constructor for manual wiring.
- HelloModelView - Class in io.jstach.opt.spring.example.hello
-
Generated Renderer.
- HelloModelView - Class in io.jstach.opt.spring.webflux.example.hello
-
Generated Renderer.
- HelloModelView() - Constructor for class io.jstach.opt.spring.example.hello.HelloModelView
-
Renderer constructor for reflection (use of() instead).
- HelloModelView() - Constructor for class io.jstach.opt.spring.webflux.example.hello.HelloModelView
-
Renderer constructor for reflection (use of() instead).
- HelloModelView(TemplateConfig) - Constructor for class io.jstach.opt.spring.example.hello.HelloModelView
-
Renderer constructor using config.
- HelloModelView(TemplateConfig) - Constructor for class io.jstach.opt.spring.webflux.example.hello.HelloModelView
-
Renderer constructor using config.
- HelloModelView(Function<Object, String>, Function<String, String>) - Constructor for class io.jstach.opt.spring.example.hello.HelloModelView
-
Renderer constructor for manual wiring.
- HelloModelView(Function<Object, String>, Function<String, String>) - Constructor for class io.jstach.opt.spring.webflux.example.hello.HelloModelView
-
Renderer constructor for manual wiring.
- Html - Class in io.jstach.jstachio.escapers
-
Provides a mustache spec based HTML escaper which is the default in normal mustache.
I
- INCREMENTAL_OPTION - Static variable in annotation interface io.jstach.jstache.JStache
-
EXPERIMENTAL: annotation processor compiler flag ("jstache.incremental") that turns on incremental compiling of supported platforms (currently only Gradle).
- INDEX_BINDING_NAME - Static variable in annotation interface io.jstach.jstache.JStache
-
A handlebars inspired virtual variable that is bound while in list contexts.
- INDEX_JMUSTACHE_BINDING_NAME - Static variable in annotation interface io.jstach.jstache.JStache
-
A JMustache inspired virtual variable that is bound while in list contexts.
- init(JStachioConfig) - Method in interface io.jstach.jstachio.spi.JStachioExtensionProvider
-
Called before the extensions are used but after
JStachioExtensionProvider.provideConfig()
. - init(JStachioConfig) - Method in class io.jstach.opt.jmustache.JMustacheRenderer
-
Deprecated.
- initialize(Bootstrap<ExampleConfiguration>) - Method in class io.jstach.opt.dropwizard.example.ExampleApplicationStart
- interfacing() - Element in annotation interface io.jstach.jstache.JStacheConfig
-
Configures what interfaces/annotations the model implements and or extends.
- io.jstach.jstache - module io.jstach.jstache
-
JStachio compile time annotations: io.jstach:jstachio-annotation.
- io.jstach.jstache - package io.jstach.jstache
-
Compile time annotations for jstachio.
- io.jstach.jstachio - module io.jstach.jstachio
-
JStachio Core Runtime API: io.jstach:jstachio.
- io.jstach.jstachio - package io.jstach.jstachio
-
JStachio Core Runtime API.
- io.jstach.jstachio.context - package io.jstach.jstachio.context
-
JStachio extended Mustache context support for context stack as well as Map and JSON tree like models.
- io.jstach.jstachio.escapers - package io.jstach.jstachio.escapers
-
Builtin Escapers.
- io.jstach.jstachio.formatters - package io.jstach.jstachio.formatters
-
Builtin Formatters.
- io.jstach.jstachio.output - package io.jstach.jstachio.output
-
Output utility classes particularly for leveraging pre-encoding efficiently and shared integration logic for plugging into web application frameworks.
- io.jstach.jstachio.spi - package io.jstach.jstachio.spi
-
JStachio Service Provider extension points API.
- io.jstach.opt.dropwizard - module io.jstach.opt.dropwizard
-
JStachio Dropwizard integration: io.jstach:jstachio-dropwizard.
- io.jstach.opt.dropwizard - package io.jstach.opt.dropwizard
-
Contains the exported Dropwizard support
- io.jstach.opt.dropwizard.example - module io.jstach.opt.dropwizard.example
-
Dropwizard example app using JStachio: io.jstach:jstachio-dropwizard-example.
- io.jstach.opt.dropwizard.example - package io.jstach.opt.dropwizard.example
-
We statically configure all annotated JStache in this package to follow the builtin dropwizard config.
- io.jstach.opt.jmustache - module io.jstach.opt.jmustache
-
JMustache extension to enable dynamic development of templates: io.jstach:jstachio-jmustache.
- io.jstach.opt.jmustache - package io.jstach.opt.jmustache
-
JMustache extension to JStachio to enable dynamic development of templates.
- io.jstach.opt.spring - module io.jstach.opt.spring
-
JStachio Spring integration module: io.jstach:jstachio-spring.
- io.jstach.opt.spring - package io.jstach.opt.spring
-
JStachio Spring Core Integration
- io.jstach.opt.spring.boot.webmvc - module io.jstach.opt.spring.boot.webmvc
-
Spring Boot Web MVC starter for JStachio: io.jstach:jstachio-spring-boot-starter-webmvc.
- io.jstach.opt.spring.boot.webmvc - package io.jstach.opt.spring.boot.webmvc
-
Spring Boot Webmvc starter
- io.jstach.opt.spring.example - module io.jstach.opt.spring.example
-
Spring Web MVC example app for JStachio: io.jstach:jstachio-spring-example.
- io.jstach.opt.spring.example - package io.jstach.opt.spring.example
-
Spring Boot MVC application using JStachio.
- io.jstach.opt.spring.example.hello - package io.jstach.opt.spring.example.hello
-
Spring Boot MVC components using JStachio.
- io.jstach.opt.spring.example.message - package io.jstach.opt.spring.example.message
-
Spring Boot MVC components using JStachio.
- io.jstach.opt.spring.web - package io.jstach.opt.spring.web
-
Spring Web integration
- io.jstach.opt.spring.webflux - module io.jstach.opt.spring.webflux
-
JStachio Spring Webflux integration module: io.jstach:jstachio-spring-webflux.
- io.jstach.opt.spring.webflux - package io.jstach.opt.spring.webflux
-
Spring Webflux integration
- io.jstach.opt.spring.webflux.example - module io.jstach.opt.spring.webflux.example
-
Spring Webflux example app for JStachio: io.jstach:jstachio-spring-webflux-example.
- io.jstach.opt.spring.webflux.example - package io.jstach.opt.spring.webflux.example
-
Spring Boot MVC application using JStachio.
- io.jstach.opt.spring.webflux.example.hello - package io.jstach.opt.spring.webflux.example.hello
-
Spring Boot WebFlux example Hello endpoint using JStachio.
- io.jstach.opt.spring.webflux.example.message - package io.jstach.opt.spring.webflux.example.message
-
Spring Boot MVC components using JStachio.
- io.jstach.opt.spring.webmvc - module io.jstach.opt.spring.webmvc
-
JStachio Spring webmvc module: io.jstach:jstachio-spring-webmvc.
- io.jstach.opt.spring.webmvc - package io.jstach.opt.spring.webmvc
-
Spring Web MVC integration
- isBroken(Object) - Method in interface io.jstach.jstachio.spi.JStachioFilter.FilterChain
-
A marker method that the filter is broken and should not be used.
- isEnabled(JStachioConfig) - Method in enum class io.jstach.jstachio.spi.Templates.TemplateLoadStrategy
-
Determine if the strategy is enabled.
- isFalsey() - Method in interface io.jstach.jstachio.context.ContextNode
-
Determines if the node is falsey.
- isFalsey() - Method in class io.jstach.jstachio.context.ObjectContext
- isFalsey(ContextNode) - Static method in interface io.jstach.jstachio.context.ContextNode
-
Determines if the node is falsey based on mustache spec semantics where:
null
, empty iterables, empty arrays and booleanfalse
are falsey however empty Map is not falsey butContextNode.empty()
is always falsey. - isFalsey(Object) - Static method in interface io.jstach.jstachio.context.ContextNode
-
Determines if an object is falsey based on mustache spec semantics where:
null
, empty iterables, empty arrays and booleanfalse
are falsey however empty Map is not falsey. - isRenderable(View) - Method in class io.jstach.opt.dropwizard.JStachioViewRenderer
- isReusable() - Method in interface io.jstach.jstachio.output.BufferedEncodedOutput
-
If this instance can be reused after
BufferedEncodedOutput.close()
is called. - isReusable() - Method in class io.jstach.jstachio.output.ByteBufferedOutputStream
- iterator() - Method in interface io.jstach.jstachio.context.ContextNode
-
If the node is a Map or a non iterable/array a singleton iterator will be returned.
- iterator() - Method in class io.jstach.jstachio.context.ObjectContext
J
- JMustacheRenderer - Class in io.jstach.opt.jmustache
-
Deprecated.This extension does not reliably mimic JStachio's mustache support unfortunately based on feedback we have decided to deprecate this and recommend using other mechanisms for hot reload.
- JMustacheRenderer() - Constructor for class io.jstach.opt.jmustache.JMustacheRenderer
-
Deprecated.No-arg constructor for ServiceLoader
- JStache - Annotation Interface in io.jstach.jstache
-
Generates a JStachio Renderer from a template and a model (the annotated class).
- JStacheCatalog - Annotation Interface in io.jstach.jstache
-
Place on package to generate a TemplateProvider/JStachioTemplateFinder that will have a catalog of all public generated JStache templates in the compile time boundary that are of type
JStacheType.JSTACHIO
. - JStacheCatalog.CatalogFlag - Enum Class in io.jstach.jstache
-
Configuration flags for generating template catalogs such
META-INF/services
files. - JStacheConfig - Annotation Interface in io.jstach.jstache
-
Set module or package level config for
JStache
annotated models that do not have the configuration explicitly set (e.g. - JStacheContentType - Annotation Interface in io.jstach.jstache
-
Register escapers or filters.
- JStacheContentType.UnspecifiedContentType - Class in io.jstach.jstache
-
A sentinel null object content type marker to auto resolve the content type based on config found elsewhere.
- JStacheFlags - Annotation Interface in io.jstach.jstache
-
Compiler feature flags that are subject to change.
- JStacheFlags.Flag - Enum Class in io.jstach.jstache
-
Compiler flags.
- JStacheFormatter - Annotation Interface in io.jstach.jstache
-
Statically registers a formatter.
- JStacheFormatter.UnspecifiedFormatter - Class in io.jstach.jstache
-
A formatter type marker to resolve the formatter based on config elsewhere.
- JStacheFormatterTypes - Annotation Interface in io.jstach.jstache
-
Statically sets allowed formatting types.
- JStacheInterfaces - Annotation Interface in io.jstach.jstache
-
This annotation is useful to force models and templates implement interfaces or have annotations particularly where you want all models to implement a lambda mixin interface.
- JStacheLambda - Annotation Interface in io.jstach.jstache
-
Tag a method to be used as a mustache lambda section for custom logic.
- JStacheLambda.Raw - Annotation Interface in io.jstach.jstache
-
Tag a method return type of String or parameter of String to be used as a raw unprocessed string.
- JStacheName - Annotation Interface in io.jstach.jstache
-
Configures how to name the generated template java code (the classes generated from JStache annotations).
- JStachePartial - Annotation Interface in io.jstach.jstache
-
Allows you to define and remap/override partials on a model (
JStache
) - JStachePartials - Annotation Interface in io.jstach.jstache
-
Allows you to define and remap/override partials on a model.
- JStachePath - Annotation Interface in io.jstach.jstache
-
Configure how the paths of templates map to actual source resources.
- JStacheType - Enum Class in io.jstach.jstache
-
Tells the annotation processor what kind of code to generate namely whether to generate full fledged jstachio templates (default
JStacheType.JSTACHIO
) or zero dependency templates (JStacheType.STACHE
). - JStacheViewSupport - Interface in io.jstach.opt.dropwizard
-
Have JStache models implement this mixin interface for easier support to generate views from models.
- jstachio - Variable in class io.jstach.opt.spring.example.hello.HelloController
-
Although not needed You can also wire in JStachio directly
- jstachio() - Method in class io.jstach.opt.dropwizard.JStachioViewRenderer
-
Internal getter for the jstachio backing this renderer
- jstachio() - Method in interface io.jstach.opt.spring.webflux.JStachioModelView
-
Returns the jstachio singleton by default.
- jstachio() - Method in interface io.jstach.opt.spring.webmvc.JStachioModelView
-
Returns the jstachio singleton by default.
- jstachio(List<JStachioExtension>) - Method in class io.jstach.opt.spring.boot.webmvc.JStachioConfiguration
-
Creates jstachio from found plugins
- jstachio(List<JStachioExtension>) - Method in class io.jstach.opt.spring.webflux.example.SpringTemplateConfig
-
Creates jstachio from found plugins
- JStachio - Interface in io.jstach.jstachio
-
Render models by using reflection or static catalog to lookup generated templates as well as apply filtering and fallback mechanisms.
- JSTACHIO - Enum constant in enum class io.jstach.jstache.JStacheType
-
The default code generation which allows reflective access to templates and requires the jstachio runtime (io.jstach.jstachio).
- JSTACHIO_JMUSTACHE_DISABLE - Static variable in class io.jstach.opt.jmustache.JMustacheRenderer
-
Deprecated.Property key to disable jmustache.
- JSTACHIO_JMUSTACHE_SOURCE_PATH - Static variable in class io.jstach.opt.jmustache.JMustacheRenderer
-
Deprecated.Property key of where jmustache will try to load template files.
- JStachioAutoConfiguration - Class in io.jstach.opt.spring.boot.webmvc
-
Auto Configures JStachio for Spring Boot.
- JStachioAutoConfiguration() - Constructor for class io.jstach.opt.spring.boot.webmvc.JStachioAutoConfiguration
-
Default constructor called by Spring
- JStachioConfig - Interface in io.jstach.jstachio.spi
-
Runtime Config Service.
- JStachioConfiguration - Class in io.jstach.opt.spring.boot.webmvc
-
Configures JStachio Spring style.
- JStachioConfiguration(ConfigurableListableBeanFactory) - Constructor for class io.jstach.opt.spring.boot.webmvc.JStachioConfiguration
-
Do nothing constructor to placate jdk 18 javadoc
- JStachioEncoder - Class in io.jstach.opt.spring.webflux
-
Encodes a JStachio model into a bytes to be used as output from a webflux reactive controller.
- JStachioEncoder(JStachio) - Constructor for class io.jstach.opt.spring.webflux.JStachioEncoder
-
Create the encoder from a JStachio
- JStachioEncoder(JStachio, int) - Constructor for class io.jstach.opt.spring.webflux.JStachioEncoder
-
Create the encoder from a JStachio
- JStachioExtension - Interface in io.jstach.jstachio.spi
-
An SPI extension point via the
ServiceLoader
or other mechanisms like DI. - JStachioExtensionProvider - Interface in io.jstach.jstachio.spi
-
An extension that is a factory that provides other extensions.
- JStachioExtensions - Interface in io.jstach.jstachio.spi
-
A container that will hold all resolved
JStachioExtension
s and consolidate them to a single instances of various services. - JStachioExtensions.Provider - Interface in io.jstach.jstachio.spi
-
A marker interface used for JStachio implementations that provide access to extensions.
- JStachioFactory - Class in io.jstach.jstachio.spi
-
Creates JStachios mainly with the
ServiceLoader
or aJStachioFactory.Builder
. - JStachioFactory.Builder - Class in io.jstach.jstachio.spi
-
Builder for creating a custom JStachio.
- JStachioFilter - Interface in io.jstach.jstachio.spi
-
Advises, intercepts or filters a template before being rendered.
- JStachioFilter.FilterChain - Interface in io.jstach.jstachio.spi
-
A fully composed chain that renders a model by applying filtering.
- JStachioHttpMessageConverter - Class in io.jstach.opt.spring.web
-
Type-safe way to use JStachio in Spring Web.
- JStachioHttpMessageConverter(JStachio) - Constructor for class io.jstach.opt.spring.web.JStachioHttpMessageConverter
-
Create http converter from jstachio
- JStachioHttpMessageConverter(JStachio, MediaType, int) - Constructor for class io.jstach.opt.spring.web.JStachioHttpMessageConverter
-
Creates a message converter with media type and buffer limit.
- JStachioModelView - Interface in io.jstach.opt.spring.webflux
-
One way to use JStachio with Spring Webflux is to use this special View that will delegate to JStachio to render.
- JStachioModelView - Interface in io.jstach.opt.spring.webmvc
-
Another way to use JStachio with Spring MVC is to have models implement Springs
View
interface. - JStachioModelViewConfigurer - Interface in io.jstach.opt.spring.webflux
-
User can provide instances in the application context and they will be applied to each
JStachioModelView
instance before rendering. - JStachioModelViewConfigurer - Interface in io.jstach.opt.spring.webmvc
-
User can provide instances in the application context and they will be applied to each
JStachioModelView
instance before rendering. - JStachioProperties - Class in io.jstach.opt.spring.boot.webmvc
-
@ConfigurationProperties
for JStachio. - JStachioProperties() - Constructor for class io.jstach.opt.spring.boot.webmvc.JStachioProperties
- jstachioService(Environment, List<Template<?>>) - Method in class io.jstach.opt.spring.webflux.example.SpringTemplateConfig
-
Creates a services based on spring objects.
- JStachioTemplateFinder - Interface in io.jstach.jstachio.spi
-
Finds templates based on the model type (class).
- JStachioTemplateFinder.SimpleTemplateFinder - Interface in io.jstach.jstachio.spi
-
An easier to implement template finder based on a sequence of templates.
- JStachioView - Interface in io.jstach.opt.dropwizard
-
An interface to mark JStachio dropwizard views
- JStachioViewRenderer - Class in io.jstach.opt.dropwizard
-
Dropwizard view support.
- JStachioViewRenderer() - Constructor for class io.jstach.opt.dropwizard.JStachioViewRenderer
-
ServiceLoader will call this
- JStachioViewRenderer(JStachio) - Constructor for class io.jstach.opt.dropwizard.JStachioViewRenderer
-
Programmatically create the renderer with the given jstachio.
- JStachioWebMvcAutoConfiguration - Class in io.jstach.opt.spring.boot.webmvc
-
MVC AutoConfiguration for JStachio runtime.
- JStachioWebMvcAutoConfiguration(JStachioHttpMessageConverter, JStachio) - Constructor for class io.jstach.opt.spring.boot.webmvc.JStachioWebMvcAutoConfiguration
-
Configures based on the jstachio found by spring
L
- LAST_BINDING_NAME - Static variable in annotation interface io.jstach.jstache.JStache
-
A handlebars inspired virtual variable that is bound while in list contexts.
- LAST_JMUSTACHE_BINDING_NAME - Static variable in annotation interface io.jstach.jstache.JStache
-
A JMustache inspired virtual variable that is bound while in list contexts.
- lastLoaded() - Method in interface io.jstach.jstachio.TemplateInfo
-
The last loaded time if applicable.
- limit - Variable in class io.jstach.jstachio.output.ThresholdEncodedOutput
-
The maximum number of bytes to buffer.
- limit() - Method in interface io.jstach.jstachio.output.LimitEncodedOutput
-
Buffer limit
- limit() - Method in class io.jstach.jstachio.output.ThresholdEncodedOutput
- limit(int, OutputFactory<OutputStream, IOException>) - Method in interface io.jstach.jstachio.output.BufferedEncodedOutput
-
Decorates this buffer so that buffering is limited to certain amount and will eventually send all output to the OutputStream created by the factory.
- LimitEncodedOutput<T,
E extends Exception> - Interface in io.jstach.jstachio.output -
This output will limit buffering by byte count and then fallback to pushing to the downstream output type of
T
once limit is exceeded. - load(Class<T>, ClassLoader, System.Logger) - Method in enum class io.jstach.jstachio.spi.Templates.TemplateLoadStrategy
-
Load the template by this strategy.
- loadFilter(Object, TemplateInfo) - Method in class io.jstach.jstachio.spi.AbstractJStachio
-
Loads the filter and checks if it can process the model and template.
- log(boolean) - Method in class io.jstach.opt.jmustache.JMustacheRenderer
-
Deprecated.Log plugin on reload.
- log(TemplateInfo) - Method in class io.jstach.opt.jmustache.JMustacheRenderer
-
Deprecated.Log template execution through jmustache
- LOGGING_DISABLE - Static variable in interface io.jstach.jstachio.spi.JStachioConfig
-
Config key to disable logging.
M
- main(String[]) - Static method in class io.jstach.opt.dropwizard.example.ExampleApplicationStart
-
Main method entrypoint for the application.
- main(String[]) - Static method in class io.jstach.opt.spring.example.App
-
Canonical entry point that will launch Spring
- main(String[]) - Static method in class io.jstach.opt.spring.webflux.example.App
-
Canonical entry point that will launch Spring
- mediaType() - Element in annotation interface io.jstach.jstache.JStacheContentType
-
Media Type of the template to help in renderer lookup.
- mediaType() - Method in interface io.jstach.opt.spring.webflux.JStachioModelView
-
The default media type for the view.
- message - Variable in class io.jstach.opt.spring.example.message.MessagePage
-
Message field we have made mutable on purpose to before rendering but after the controller is done.
- message - Variable in class io.jstach.opt.spring.webflux.example.message.MessagePage
-
An example of field access.
- message() - Method in record class io.jstach.opt.dropwizard.example.ExampleModel
-
Returns the value of the
message
record component. - message() - Method in record class io.jstach.opt.spring.example.hello.HelloModel
-
Returns the value of the
message
record component. - message() - Method in record class io.jstach.opt.spring.example.hello.HelloModelAndView
-
Returns the value of the
message
record component. - message() - Method in class io.jstach.opt.spring.example.message.MessageController
-
Here we use the global configurer to inject state into the
View
. - message() - Method in record class io.jstach.opt.spring.webflux.example.hello.HelloModel
-
Returns the value of the
message
record component. - message() - Method in class io.jstach.opt.spring.webflux.example.message.MessageController
-
Here we use the global configurer to inject state into the
View
. - MessageConfiguration - Class in io.jstach.opt.spring.example.message
-
Message wiring.
- MessageConfiguration - Class in io.jstach.opt.spring.webflux.example.message
-
Spring configuration to add a
JStachioModelViewConfigurer
for MessagePage. - MessageConfiguration() - Constructor for class io.jstach.opt.spring.example.message.MessageConfiguration
-
Created by Spring
- MessageConfiguration() - Constructor for class io.jstach.opt.spring.webflux.example.message.MessageConfiguration
-
Called by Spring
- MessageController - Class in io.jstach.opt.spring.example.message
-
Example controller that uses a View which has global state injected into it via a handler interceptor.
- MessageController - Class in io.jstach.opt.spring.webflux.example.message
-
Example controller that uses a View which has global state injected into it via a handler interceptor.
- MessageController() - Constructor for class io.jstach.opt.spring.example.message.MessageController
-
Created by Spring
- MessageController() - Constructor for class io.jstach.opt.spring.webflux.example.message.MessageController
-
Called by Spring
- messageConverter(JStachio, JStachioProperties) - Method in class io.jstach.opt.spring.boot.webmvc.JStachioConfiguration
-
Creates a message converter from Spring JStachio
- MessagePage - Class in io.jstach.opt.spring.example.message
-
Model using a configurer to add state.
- MessagePage - Class in io.jstach.opt.spring.webflux.example.message
-
Model using a configurer to add state.
- MessagePage() - Constructor for class io.jstach.opt.spring.example.message.MessagePage
-
Default constructor required for javadoc 18+
- MessagePage() - Constructor for class io.jstach.opt.spring.webflux.example.message.MessagePage
-
Creates a mutable MessagePage
- MessagePageRenderer - Class in io.jstach.opt.spring.example.message
-
Generated Renderer.
- MessagePageRenderer - Class in io.jstach.opt.spring.webflux.example.message
-
Generated Renderer.
- MessagePageRenderer() - Constructor for class io.jstach.opt.spring.example.message.MessagePageRenderer
-
Renderer constructor for reflection (use of() instead).
- MessagePageRenderer() - Constructor for class io.jstach.opt.spring.webflux.example.message.MessagePageRenderer
-
Renderer constructor for reflection (use of() instead).
- MessagePageRenderer(TemplateConfig) - Constructor for class io.jstach.opt.spring.example.message.MessagePageRenderer
-
Renderer constructor using config.
- MessagePageRenderer(TemplateConfig) - Constructor for class io.jstach.opt.spring.webflux.example.message.MessagePageRenderer
-
Renderer constructor using config.
- MessagePageRenderer(Function<Object, String>, Function<String, String>) - Constructor for class io.jstach.opt.spring.example.message.MessagePageRenderer
-
Renderer constructor for manual wiring.
- MessagePageRenderer(Function<Object, String>, Function<String, String>) - Constructor for class io.jstach.opt.spring.webflux.example.message.MessagePageRenderer
-
Renderer constructor for manual wiring.
- model() - Method in interface io.jstach.jstachio.TemplateModel
-
Model.
- model() - Method in class io.jstach.opt.dropwizard.DefaultJStachioView
- model() - Method in interface io.jstach.opt.dropwizard.JStachioView
-
The JStache annotated instance
- model() - Method in interface io.jstach.opt.spring.webflux.JStachioModelView
-
The model to be rendered by
JStachioModelView.jstachio()
. - model() - Method in interface io.jstach.opt.spring.webmvc.JStachioModelView
-
The model to be rendered by
JStachioModelView.jstachio()
. - model(T) - Method in interface io.jstach.jstachio.Template.EncodedTemplate
- model(T) - Method in interface io.jstach.jstachio.Template
-
Creates a template model pair.
- modelClass() - Method in interface io.jstach.jstachio.TemplateInfo
-
Return the model class (root context class annotated with JStache) that generated this template.
- modelClass() - Method in class io.jstach.opt.dropwizard.example.ExampleModelRenderer
-
Model class.
- modelClass() - Method in class io.jstach.opt.spring.example.hello.HelloModelAndViewView
-
Model class.
- modelClass() - Method in class io.jstach.opt.spring.example.hello.HelloModelView
-
Model class.
- modelClass() - Method in class io.jstach.opt.spring.example.message.MessagePageRenderer
-
Model class.
- modelClass() - Method in class io.jstach.opt.spring.webflux.example.hello.HelloModelView
-
Model class.
- modelClass() - Method in class io.jstach.opt.spring.webflux.example.message.MessagePageRenderer
-
Model class.
- modelImplements() - Element in annotation interface io.jstach.jstache.JStacheInterfaces
-
Will check that all models in the annotated class/package/module annotated with
JStache
implement the array of interfaces. - msg() - Method in class io.jstach.opt.spring.example.message.MessageController
-
Here we use the return value type to construct a
View
that will be rendered. - mvc() - Method in class io.jstach.opt.spring.example.hello.HelloController
-
Here we could use
JStacheInterfaces
to make our model implementJStachioModelView
to support the traditional servlet MVC approach. - mvc() - Method in class io.jstach.opt.spring.webflux.example.hello.HelloController
-
Here we use
JStacheInterfaces
to make our model implement a Spring View to support the traditional servlet MVC approach.
N
- name() - Element in annotation interface io.jstach.jstache.JStache
-
Name of generated class.
- name() - Element in annotation interface io.jstach.jstache.JStacheCatalog
-
Name of the generated class that will be put in the annotated package.
- name() - Element in annotation interface io.jstach.jstache.JStacheLambda
-
The logical name of the lambda.
- name() - Element in annotation interface io.jstach.jstache.JStachePartial
-
The logical name of the template.
- naming() - Element in annotation interface io.jstach.jstache.JStacheConfig
-
If
JStache.name()
is blank the name of the generated class is derived from the models class name and then augmented withJStacheName.prefix()
andJStacheName.suffix()
. - NO_INVERTED_BROKEN_CHAIN - Enum constant in enum class io.jstach.jstache.JStacheFlags.Flag
-
Per mustache spec dotted names can actually not exist at all for inverted sections.
- NO_NULL_CHECKING - Enum constant in enum class io.jstach.jstache.JStacheFlags.Flag
-
EXPERIMENTAL: Normally falsey is either empty list, boolean false, or
null
. - noopLogger() - Static method in interface io.jstach.jstachio.spi.JStachioConfig
-
NOOP Logger that will not trigger initialization of the System
System.Logger
facilities. - normalizePath() - Method in interface io.jstach.jstachio.TemplateInfo
-
Normalizes the path to used by
ClassLoader.getResource(String)
. - nullableAnnotation() - Element in annotation interface io.jstach.jstache.JStacheFlags
-
EXPERIMENTAL: Annotation to use for marking nullable types in generated code.
O
- object() - Method in interface io.jstach.jstachio.context.ContextNode
-
The object being wrapped.
- object() - Method in class io.jstach.jstachio.context.ObjectContext
- ObjectContext - Class in io.jstach.jstachio.context
-
Extend this class to make
JStache
model act like JSON object or a java.util.Map. - ObjectContext() - Constructor for class io.jstach.jstachio.context.ObjectContext
- of() - Static method in class io.jstach.jstachio.escapers.Html
-
Provides the escaper.
- of() - Static method in class io.jstach.jstachio.escapers.PlainText
-
Provides the escaper for static lookup.
- of() - Static method in interface io.jstach.jstachio.formatters.DefaultFormatter
-
Provides the default formatter for static lookup.
- of() - Static method in interface io.jstach.jstachio.JStachio
-
Gets the static singleton jstachio.
- of() - Static method in interface io.jstach.jstachio.spi.JStachioExtensions
-
Resolves extensions from the
ServiceLoader
withJStachioExtension
as the SPI. - of() - Static method in class io.jstach.opt.dropwizard.example.ExampleModelRenderer
-
Convience static factory that will reuse the same singleton instance.
- of() - Static method in class io.jstach.opt.spring.example.hello.HelloModelAndViewView
-
Convience static factory that will reuse the same singleton instance.
- of() - Static method in class io.jstach.opt.spring.example.hello.HelloModelView
-
Convience static factory that will reuse the same singleton instance.
- of() - Static method in class io.jstach.opt.spring.example.message.MessagePageRenderer
-
Convience static factory that will reuse the same singleton instance.
- of() - Static method in class io.jstach.opt.spring.webflux.example.hello.HelloModelView
-
Convience static factory that will reuse the same singleton instance.
- of() - Static method in class io.jstach.opt.spring.webflux.example.message.MessagePageRenderer
-
Convience static factory that will reuse the same singleton instance.
- of(JStachio) - Static method in interface io.jstach.jstachio.context.ContextJStachio
-
Decorates a JStachio instance as a
ContextJStachio
if it is not already one. - of(JStachioExtension) - Static method in interface io.jstach.jstachio.spi.JStachioExtensionProvider
-
Creates a provider from an extension.
- of(JStachioFilter, TemplateInfo) - Static method in interface io.jstach.jstachio.spi.JStachioFilter.FilterChain
-
Create the filter chain from the filter and a template by resolving the first filter.
- of(Template.EncodedTemplate<T>, T) - Static method in interface io.jstach.jstachio.TemplateModel
-
Creates a template model pair.
- of(Template<T>) - Static method in interface io.jstach.jstachio.context.ContextTemplate
-
Creates a context template from a regular template if is not already a context template.
- of(Template<T>, T) - Static method in interface io.jstach.jstachio.TemplateModel
-
Creates a template model pair.
- of(OutputStream, Charset) - Static method in interface io.jstach.jstachio.Output.EncodedOutput
-
Adapts an
OutputStream
as anOutput.EncodedOutput
. - of(OutputStream, Charset) - Static method in interface io.jstach.jstachio.Output
-
Adapts an
OutputStream
as anOutput
. - of(Appendable) - Static method in interface io.jstach.jstachio.Output
-
Adapts an
Appendable
as anOutput
. - of(Iterable<? extends JStachioExtension>) - Static method in interface io.jstach.jstachio.spi.JStachioExtensions
-
Resolve from an iterable of extensions that usually come from some discovery mechanism like the
ServiceLoader
or a DI framework. - of(Iterable<? extends TemplateInfo>, int) - Static method in interface io.jstach.jstachio.spi.JStachioTemplateFinder
-
Creates a template finder from an iterable of templates.
- of(Object) - Static method in interface io.jstach.opt.dropwizard.JStachioView
-
Creates a dropwizard view from a model object
- of(Object) - Static method in interface io.jstach.opt.spring.webflux.JStachioModelView
-
Creates a spring view from a model
- of(Object) - Static method in interface io.jstach.opt.spring.webmvc.JStachioModelView
-
Creates a spring view from a model with content type: "
text/html; charset=UTF-8
". - of(Object, String) - Static method in interface io.jstach.opt.spring.webmvc.JStachioModelView
-
Creates a spring view from a model.
- of(Object, MediaType) - Static method in interface io.jstach.opt.spring.webmvc.JStachioModelView
-
Creates a spring view from a model.
- of(Object, MediaType, JStachio) - Static method in interface io.jstach.opt.spring.webmvc.JStachioModelView
-
Creates a spring view from a model.
- of(StringBuilder) - Static method in interface io.jstach.jstachio.Output
-
Adapts a
StringBuilder
as anOutput
. - of(Function<Object, String>) - Static method in interface io.jstach.jstachio.Formatter
-
Adapts a function to a formatter.
- of(Function<String, ?>) - Static method in interface io.jstach.jstachio.context.ContextNode
-
Creates a root context node with the given function to look up children.
- of(Function<String, String>) - Static method in interface io.jstach.jstachio.Escaper
-
Adapts a function to an Escaper.
- of(List<? extends JStachioTemplateFinder>) - Static method in interface io.jstach.jstachio.spi.JStachioTemplateFinder
-
Creates a composite template finder from a list.
- of(Stream<? extends JStachioExtension>) - Static method in interface io.jstach.jstachio.spi.JStachioExtensions
-
Resolve from a stream of extensions that usually come from some discovery mechanism like the
ServiceLoader
or a DI framework. - ofByteArray(Charset) - Static method in interface io.jstach.jstachio.output.ByteBufferEncodedOutput
-
Calls
ByteBufferEncodedOutput.ofByteArray(Charset, int)
with initial size of 4096. - ofByteArray(Charset, int) - Static method in interface io.jstach.jstachio.output.ByteBufferEncodedOutput
-
Create a buffered encoded output backed by an array that will grow as needed analagous to StringBuilder and/or
ByteArrayOutputStream
. - ofByteArrays(Charset) - Static method in interface io.jstach.jstachio.output.ChunkEncodedOutput
-
A chunk encoded output backed by a list of byte arrays
- ofChild(int, Object) - Method in class io.jstach.jstachio.context.ObjectContext
-
Creates an indexed child node off of this node where the return child nodes parent will be this node.
- ofChild(String, Object) - Method in class io.jstach.jstachio.context.ObjectContext
-
Creates a named child node off of this node where the return child nodes parent will be this node.
- ofChunked(Charset) - Static method in interface io.jstach.jstachio.output.BufferedEncodedOutput
-
Create a buffered encoded output backed by a sequence of chunks.
- ofRoot(Object) - Static method in interface io.jstach.jstachio.context.ContextNode
-
Creates the root node from an Object.
- order() - Method in interface io.jstach.jstachio.spi.JStachioFilter
-
Hint on order of filter chain.
- order() - Method in interface io.jstach.jstachio.spi.JStachioTemplateFinder
-
Hint on order of template finders.
- Output<E extends Exception> - Interface in io.jstach.jstachio
-
A low level abstraction and implementation detail analogous to
Appendable
andDataOutput
. - Output.CloseableEncodedOutput<E extends Exception> - Interface in io.jstach.jstachio
-
An encoded output that can be closed.
- Output.EncodedOutput<E extends Exception> - Interface in io.jstach.jstachio
-
A specialized Output designed for pre-encoded templates that have already encoded byte arrays to be used directly.
- Output.StringOutput - Class in io.jstach.jstachio
-
String Builder based output.
- OutputConsumer<E extends Exception> - Interface in io.jstach.jstachio.output
-
An OutputStream like callback.
- OutputFactory<T,
E extends Exception> - Interface in io.jstach.jstachio.output -
Creates output like objects with a buffer size.
- OutputStreamThresholdEncodedOutput(Charset, int) - Constructor for class io.jstach.jstachio.output.ThresholdEncodedOutput.OutputStreamThresholdEncodedOutput
-
Create with charset and limit.
P
- parent() - Method in interface io.jstach.jstachio.context.ContextNode
-
The parent node.
- parent() - Method in class io.jstach.jstachio.context.ObjectContext
- path() - Element in annotation interface io.jstach.jstache.JStache
-
Resource path to template
- path() - Element in annotation interface io.jstach.jstache.JStachePartial
-
The physical path of the template.
- pathing() - Element in annotation interface io.jstach.jstache.JStacheConfig
-
If
JStache.path()
is not blank the path of the template is resolved by augmenting withJStachePath.prefix()
andJStachePath.suffix()
. - patterns() - Element in annotation interface io.jstach.jstache.JStacheFormatterTypes
-
List of regex used to match whitelist class names that are allowed to be formatted.
- PlainText - Class in io.jstach.jstachio.escapers
-
Provides NOOP escaper for working with plain text.
- postHandle(HttpServletRequest, HttpServletResponse, Object, ModelAndView) - Method in class io.jstach.opt.spring.webmvc.ViewResolvingHandlerInterceptor
-
If the model contains an attribute that is a
JStache
model, in particular if it has been the result of aController
method, then it will be automatically converted into aJStachioModelView
. - postHandle(HttpServletRequest, HttpServletResponse, Object, ModelAndView) - Method in class io.jstach.opt.spring.webmvc.ViewSetupHandlerInterceptor
-
If the modelAndView is a
JStachioModelView
then it will be configured with all of the foundJStachioModelViewConfigurer
in the application context. - postProcessAfterInitialization(Object, String) - Method in class io.jstach.opt.spring.webflux.ViewSetupBeanPostProcessor
-
Look for a
ViewResolutionResultHandler
and replace it with a wrapper that configuresJStachioModelView
instance using theJStachioModelViewConfigurer
s in the current context. - PRE_ENCODE_DISABLE - Enum constant in enum class io.jstach.jstache.JStacheFlags.Flag
-
If set the templates will NOT have pre-encoded bytes of the static parts of the template and the generated
JStacheType.JSTACHIO
code will not implementio.jstach.jstachio.Template.EncodedTemplate
. - prefix() - Element in annotation interface io.jstach.jstache.JStacheName
-
If
JStache.name()
is blank the name of the generated class is derived from the models class name plus the return value if the return value is not ""*"". - prefix() - Element in annotation interface io.jstach.jstache.JStachePath
-
Will prefix the path.
- prefix() - Method in interface io.jstach.jstachio.spi.Templates.PathInfo
-
Resolved prefix.
- prefix(String) - Method in class io.jstach.opt.jmustache.JMustacheRenderer
-
Deprecated.A prefix to add to the output to know that JMustache is being used.
- process(Object, Output<?>) - Method in interface io.jstach.jstachio.spi.JStachioFilter.FilterChain
-
Renders the passed in model.
- provideConfig() - Method in interface io.jstach.jstachio.spi.JStachioExtensionProvider
-
Provide a config or not.
- provideConfig() - Method in class io.jstach.opt.spring.SpringJStachioExtension
-
Provide a config or not.
- provideFilter() - Method in interface io.jstach.jstachio.spi.JStachioExtensionProvider
-
Provide a filter or not.
- provideFilter() - Method in class io.jstach.opt.jmustache.JMustacheRenderer
-
Provide a filter or not.
- provider() - Static method in class io.jstach.jstachio.escapers.Html
-
Provides the escaper.
- provider() - Static method in class io.jstach.jstachio.escapers.PlainText
-
Provides the escaper for static lookup.
- provider() - Static method in interface io.jstach.jstachio.formatters.DefaultFormatter
-
Provides the default formatter for static lookup.
- provider() - Static method in interface io.jstach.jstachio.formatters.SpecFormatter
-
Provides the formatter for static lookup.
- providesMethod() - Element in annotation interface io.jstach.jstache.JStacheContentType
-
A static method that will return an implementation of
io.jstach.api.runtime.Escaper
orFunction<String,String>
- providesMethod() - Element in annotation interface io.jstach.jstache.JStacheFormatter
-
A static method that will return an implementation of
io.jstach.api.runtime.Formatter
orFunction<Object,String>
- provideTemplateFinder() - Method in interface io.jstach.jstachio.spi.JStachioExtensionProvider
-
Provide a template finder or not.
- provideTemplateFinder() - Method in class io.jstach.opt.spring.SpringJStachioExtension
-
Provide a template finder or not.
- provideTemplates() - Method in interface io.jstach.jstachio.spi.TemplateProvider
-
Provides templates with empty config.
- provideTemplates(TemplateConfig) - Method in interface io.jstach.jstachio.spi.TemplateProvider
-
Provides a list of instantiated renderers.
- provideTemplates(TemplateConfig) - Method in class io.jstach.opt.spring.example.TemplateCatalog
R
- readInternal(Class<? extends Object>, HttpInputMessage) - Method in class io.jstach.opt.spring.web.JStachioHttpMessageConverter
- REFLECTION_TEMPLATE_DISABLE - Static variable in interface io.jstach.jstachio.spi.JStachioConfig
-
Config key to disable non service loader reflection based lookup of templates.
- render(Map<String, ?>, MediaType, ServerWebExchange) - Method in interface io.jstach.opt.spring.webflux.JStachioModelView
- render(View, Locale, OutputStream) - Method in class io.jstach.opt.dropwizard.JStachioViewRenderer
- render(ExampleModel, A, Formatter, Appender, Appender) - Static method in class io.jstach.opt.dropwizard.example.ExampleModelRenderer
-
Renders the passed in model.
- render(ExampleModelRenderer, ExampleModel, ContextNode, A, Formatter, Appender, Appender) - Static method in class io.jstach.opt.dropwizard.example.ExampleModelRenderer
-
Renders the passed in model.
- render(HelloModelAndView, A, Formatter, Appender, Appender) - Static method in class io.jstach.opt.spring.example.hello.HelloModelAndViewView
-
Renders the passed in model.
- render(HelloModelAndViewView, HelloModelAndView, ContextNode, A, Formatter, Appender, Appender) - Static method in class io.jstach.opt.spring.example.hello.HelloModelAndViewView
-
Renders the passed in model.
- render(HelloModel, A, Formatter, Appender, Appender) - Static method in class io.jstach.opt.spring.example.hello.HelloModelView
-
Renders the passed in model.
- render(HelloModelView, HelloModel, ContextNode, A, Formatter, Appender, Appender) - Static method in class io.jstach.opt.spring.example.hello.HelloModelView
-
Renders the passed in model.
- render(MessagePage, A, Formatter, Appender, Appender) - Static method in class io.jstach.opt.spring.example.message.MessagePageRenderer
-
Renders the passed in model.
- render(MessagePageRenderer, MessagePage, ContextNode, A, Formatter, Appender, Appender) - Static method in class io.jstach.opt.spring.example.message.MessagePageRenderer
-
Renders the passed in model.
- render(HelloModel, A, Formatter, Appender, Appender) - Static method in class io.jstach.opt.spring.webflux.example.hello.HelloModelView
-
Renders the passed in model.
- render(HelloModelView, HelloModel, ContextNode, A, Formatter, Appender, Appender) - Static method in class io.jstach.opt.spring.webflux.example.hello.HelloModelView
-
Renders the passed in model.
- render(MessagePage, A, Formatter, Appender, Appender) - Static method in class io.jstach.opt.spring.webflux.example.message.MessagePageRenderer
-
Renders the passed in model.
- render(MessagePageRenderer, MessagePage, ContextNode, A, Formatter, Appender, Appender) - Static method in class io.jstach.opt.spring.webflux.example.message.MessagePageRenderer
-
Renders the passed in model.
- render(Object) - Static method in interface io.jstach.jstachio.JStachio
-
Executes the ServiceLoader instance of JStachio
JStachio.execute(Object)
. - render(Object, Appendable) - Static method in interface io.jstach.jstachio.JStachio
-
Executes the ServiceLoader instance of JStachio
JStachio.execute(Object, Appendable)
. - render(Object, StringBuilder) - Static method in interface io.jstach.jstachio.JStachio
-
Executes the ServiceLoader instance of JStachio
JStachio.execute(Object, StringBuilder)
. - render(Map<String, ?>, HttpServletRequest, HttpServletResponse) - Method in interface io.jstach.opt.spring.webmvc.JStachioModelView
- Renderer<T> - Interface in io.jstach.jstachio
-
Renders models of type
T
by writing to an Appendable. - renderString() - Method in interface io.jstach.jstachio.context.ContextNode
-
Convenience method for calling
toString
on the wrapped object. - requireProperty(String, String) - Method in interface io.jstach.jstachio.spi.JStachioConfig
-
A NonNull friendly analog of
System.getProperty(String, String)
that will never return null unlike System.getProperty which is PolyNull. - resolve(Object) - Static method in interface io.jstach.jstachio.context.ContextNode
-
Resolves the context node from an object.
- resolve(Object, Object) - Static method in interface io.jstach.jstachio.context.ContextNode
-
Resolves the context node trying first and then second.
- resolveFullPath(String) - Method in interface io.jstach.jstachio.spi.Templates.PathInfo
-
Calculates the expanded path and if the supplied path is empty then the path will be expanded based on the class name where package name are separated with a slash ("
/
") instead of a ".
" and is suffixed with ".mustache" if suffix isJStachePath.UNSPECIFIED
. - resolvePath(Class<?>) - Static method in class io.jstach.jstachio.spi.Templates
-
Deprecated.
- RESOURCE - Enum constant in enum class io.jstach.jstachio.TemplateInfo.TemplateSource
-
Template was retrieved from the classpath at compile time.
- RESOURCES_PATH_OPTION - Static variable in annotation interface io.jstach.jstache.JStache
-
An annotation processor compiler flag ("jstache.resourcesPath") that says where the templates files are located.
- ROOT_BINDING_NAME - Static variable in annotation interface io.jstach.jstache.JStache
-
A virtual variable that is direct analog to handlebars
@root
. - run(ExampleConfiguration, Environment) - Method in class io.jstach.opt.dropwizard.example.ExampleApplicationStart
S
- SECTION_PARTIAL_NAME - Static variable in annotation interface io.jstach.jstache.JStacheLambda
-
Name of the partial to render the section body of a lambda call.
- SERVICE_LOADER - Enum constant in enum class io.jstach.jstachio.spi.Templates.TemplateLoadStrategy
-
Strategy that will try the
ServiceLoader
with the SPI ofTemplateProvider
. - SERVICELOADER_TEMPLATE_DISABLE - Static variable in interface io.jstach.jstachio.spi.JStachioConfig
-
Config key to disable service loader based lookup of templates.
- ServletJStachioHttpMessageConverter - Class in io.jstach.opt.spring.webmvc
-
A servlet server aware
JStachioHttpMessageConverter
that will leverageServletResponse.setBufferSize(int)
to reduce duplicate buffering. - ServletJStachioHttpMessageConverter(JStachio, MediaType, int) - Constructor for class io.jstach.opt.spring.webmvc.ServletJStachioHttpMessageConverter
- setApplicationContext(ApplicationContext) - Method in class io.jstach.opt.spring.boot.webmvc.JStachioWebMvcAutoConfiguration
- setBufferLimit(int) - Method in class io.jstach.opt.spring.boot.webmvc.JStachioProperties
- setMediaType(MediaType) - Method in class io.jstach.opt.spring.boot.webmvc.JStachioProperties
- setStatic(Supplier<JStachio>) - Static method in interface io.jstach.jstachio.JStachio
-
Set the static singleton of JStachio.
- size() - Method in interface io.jstach.jstachio.output.BufferedEncodedOutput
-
Total size in number of bytes of the output.
- size() - Method in class io.jstach.jstachio.output.ByteBufferedOutputStream
-
How many bytes have been written so far.
- size() - Method in interface io.jstach.jstachio.output.LimitEncodedOutput
-
Current amount of bytes written.
- size() - Method in class io.jstach.jstachio.output.ThresholdEncodedOutput
-
This is the current written length.
- sourcePath(String) - Method in class io.jstach.opt.jmustache.JMustacheRenderer
-
Deprecated.Sets the relative to the project sourcePath for runtime lookup of templates.
- SpecFormatter - Interface in io.jstach.jstachio.formatters
-
Formatter that follows the spec rules that if a variable is
null
it will be an empty string (ie NOOP). - SpringJStacheConfig - Enum Class in io.jstach.opt.spring
-
Static config for Spring Boot like conventions of finding templates in
classpath:/templates
. - SpringJStachio - Class in io.jstach.opt.spring
-
A JStachio that does not use the service loader.
- SpringJStachio(JStachioExtensions) - Constructor for class io.jstach.opt.spring.SpringJStachio
-
Passed the found services usually injected by Spring.
- SpringJStachio(List<JStachioExtension>) - Constructor for class io.jstach.opt.spring.SpringJStachio
-
Passed the found services usually injected by Spring.
- springJStachioExtension(JStachioConfig, JStachioTemplateFinder) - Method in class io.jstach.opt.spring.boot.webmvc.JStachioConfiguration
-
Creates a services based on spring objects.
- SpringJStachioExtension - Class in io.jstach.opt.spring
-
JStachio services based on Spring notably the config and template finding.
- SpringJStachioExtension(JStachioConfig, JStachioTemplateFinder) - Constructor for class io.jstach.opt.spring.SpringJStachioExtension
-
Constructor for injection
- SpringJStachioExtension(Environment, List<Template<?>>) - Constructor for class io.jstach.opt.spring.SpringJStachioExtension
-
Constructor for injection
- SpringTemplateConfig - Class in io.jstach.opt.spring.webflux.example
-
Configures JStachio Spring style.
- SpringTemplateConfig() - Constructor for class io.jstach.opt.spring.webflux.example.SpringTemplateConfig
-
Do nothing constructor to placate jdk 18 javadoc
- STACHE - Enum constant in enum class io.jstach.jstache.JStacheType
-
Zero runtime dependency renderers are generated if this is selected.
- STRING - Enum constant in enum class io.jstach.jstachio.TemplateInfo.TemplateSource
-
Template was inlined as a String literal
- StringOutput(StringBuilder) - Constructor for class io.jstach.jstachio.Output.StringOutput
-
Create using supplied StringBuilder.
- suffix() - Element in annotation interface io.jstach.jstache.JStacheName
-
If
JStache.name()
is blank the name of the generated class is derived from the models class name plus the return value if the return value is not ""*"". - suffix() - Element in annotation interface io.jstach.jstache.JStachePath
-
Suffix the path.
- suffix() - Method in interface io.jstach.jstachio.spi.Templates.PathInfo
-
Resolved suffix.
- suffix(String) - Method in class io.jstach.opt.jmustache.JMustacheRenderer
-
Deprecated.A suffix to append to the output to know that JMustache is being used.
- supports(Class<?>) - Method in class io.jstach.opt.spring.web.JStachioHttpMessageConverter
- supportsType(Class<?>) - Method in interface io.jstach.jstachio.JStachio
-
Determines if this jstachio can render the model type (the class annotated by JStache).
- supportsType(Class<?>) - Method in class io.jstach.jstachio.spi.AbstractJStachio
- supportsType(Class<?>) - Method in interface io.jstach.jstachio.spi.JStachioTemplateFinder.SimpleTemplateFinder
- supportsType(Class<?>) - Method in interface io.jstach.jstachio.spi.JStachioTemplateFinder
-
Determines if this template finder has a template for the model type (the class annotated by JStache).
- supportsType(Class<?>) - Method in interface io.jstach.jstachio.TemplateInfo
-
Checks to see if a template supports the model class.
- supportsType(Class<?>) - Method in class io.jstach.opt.dropwizard.example.ExampleModelRenderer
- supportsType(Class<?>) - Method in class io.jstach.opt.spring.example.hello.HelloModelAndViewView
- supportsType(Class<?>) - Method in class io.jstach.opt.spring.example.hello.HelloModelView
- supportsType(Class<?>) - Method in class io.jstach.opt.spring.example.message.MessagePageRenderer
- supportsType(Class<?>) - Method in class io.jstach.opt.spring.webflux.example.hello.HelloModelView
- supportsType(Class<?>) - Method in class io.jstach.opt.spring.webflux.example.message.MessagePageRenderer
T
- template() - Element in annotation interface io.jstach.jstache.JStache
-
Inline the template as a Java string instead of a file.
- template() - Element in annotation interface io.jstach.jstache.JStacheLambda
-
An inline template used for rendering the returned model that has access to the lambda section body as a partial.
- template() - Element in annotation interface io.jstach.jstache.JStachePartial
-
Inline template.
- template() - Method in interface io.jstach.jstachio.TemplateModel
-
Template.
- template() - Method in class io.jstach.opt.dropwizard.example.ExampleResource
-
For this endpoint we use generated template directly and use a mixin method that will generate the view from the model.
- template(Class<?>) - Method in class io.jstach.jstachio.spi.AbstractJStachio
-
Finds the template by model class wrapping any exceptions.
- Template<T> - Interface in io.jstach.jstachio
-
A JStachio Template is a renderer that has template meta data.
- TEMPLATE_BINDING_NAME - Static variable in interface io.jstach.jstachio.TemplateInfo
-
The template instance is accessible to mustache templates with this global binding name.
- Template.EncodedTemplate<T> - Interface in io.jstach.jstachio
-
EXPERIMENTAL support of pre-encoded templates that have the static parts of the template already encoded into bytes.
- templateAnnotations() - Element in annotation interface io.jstach.jstache.JStacheInterfaces
-
Will make all generated templates that are in the annotated class/package/module be annotated with the array of annotations.
- templateAppender() - Method in class io.jstach.opt.dropwizard.example.ExampleModelRenderer
-
Appender.
- templateAppender() - Method in class io.jstach.opt.spring.example.hello.HelloModelAndViewView
-
Appender.
- templateAppender() - Method in class io.jstach.opt.spring.example.hello.HelloModelView
-
Appender.
- templateAppender() - Method in class io.jstach.opt.spring.example.message.MessagePageRenderer
-
Appender.
- templateAppender() - Method in class io.jstach.opt.spring.webflux.example.hello.HelloModelView
-
Appender.
- templateAppender() - Method in class io.jstach.opt.spring.webflux.example.message.MessagePageRenderer
-
Appender.
- TemplateCatalog - Class in io.jstach.opt.spring.example
-
Generated template catalog.
- TemplateCatalog() - Constructor for class io.jstach.opt.spring.example.TemplateCatalog
-
Generated template catalog constructor for ServiceLoader.
- templateCharset() - Method in interface io.jstach.jstachio.TemplateInfo
-
The template
Charset
which is the original format of the template file and should ideally be used when encoding an HTTP response or similar. - templateCharset() - Method in class io.jstach.opt.dropwizard.example.ExampleModelRenderer
- templateCharset() - Method in class io.jstach.opt.spring.example.hello.HelloModelAndViewView
- templateCharset() - Method in class io.jstach.opt.spring.example.hello.HelloModelView
- templateCharset() - Method in class io.jstach.opt.spring.example.message.MessagePageRenderer
- templateCharset() - Method in class io.jstach.opt.spring.webflux.example.hello.HelloModelView
- templateCharset() - Method in class io.jstach.opt.spring.webflux.example.message.MessagePageRenderer
- templateConfig() - Method in class io.jstach.opt.spring.boot.webmvc.JStachioConfiguration
-
The default template config is empty and will let each template resolve its own config.
- TemplateConfig - Interface in io.jstach.jstachio
-
A Container for optional template collaborators for ease of wiring generated
Template
s. - templateContentType() - Method in interface io.jstach.jstachio.TemplateInfo
-
The template content type is the class annotated with
JStacheContentType
which also describes the escaper to be used. - templateContentType() - Method in class io.jstach.opt.dropwizard.example.ExampleModelRenderer
- templateContentType() - Method in class io.jstach.opt.spring.example.hello.HelloModelAndViewView
- templateContentType() - Method in class io.jstach.opt.spring.example.hello.HelloModelView
- templateContentType() - Method in class io.jstach.opt.spring.example.message.MessagePageRenderer
- templateContentType() - Method in class io.jstach.opt.spring.webflux.example.hello.HelloModelView
- templateContentType() - Method in class io.jstach.opt.spring.webflux.example.message.MessagePageRenderer
- templateEscaper() - Method in interface io.jstach.jstachio.TemplateInfo
-
The escaper to be used on the template.
- templateEscaper() - Method in class io.jstach.opt.dropwizard.example.ExampleModelRenderer
- templateEscaper() - Method in class io.jstach.opt.spring.example.hello.HelloModelAndViewView
- templateEscaper() - Method in class io.jstach.opt.spring.example.hello.HelloModelView
- templateEscaper() - Method in class io.jstach.opt.spring.example.message.MessagePageRenderer
- templateEscaper() - Method in class io.jstach.opt.spring.webflux.example.hello.HelloModelView
- templateEscaper() - Method in class io.jstach.opt.spring.webflux.example.message.MessagePageRenderer
- templateExtends() - Element in annotation interface io.jstach.jstache.JStacheInterfaces
-
Will make all generated templates that are in the annotated class/package/module extened a class.
- templateFinder(JStachioConfig, TemplateConfig) - Method in class io.jstach.opt.spring.boot.webmvc.JStachioConfiguration
-
Resolve template finder configs
- templateFormatter() - Method in interface io.jstach.jstachio.TemplateInfo
-
The base formatter to be used on the template.
- templateFormatter() - Method in class io.jstach.opt.dropwizard.example.ExampleModelRenderer
- templateFormatter() - Method in class io.jstach.opt.spring.example.hello.HelloModelAndViewView
- templateFormatter() - Method in class io.jstach.opt.spring.example.hello.HelloModelView
- templateFormatter() - Method in class io.jstach.opt.spring.example.message.MessagePageRenderer
- templateFormatter() - Method in class io.jstach.opt.spring.webflux.example.hello.HelloModelView
- templateFormatter() - Method in class io.jstach.opt.spring.webflux.example.message.MessagePageRenderer
- templateImplements() - Element in annotation interface io.jstach.jstache.JStacheInterfaces
-
Will make all generated templates that are in the annotated class/package/module implement the array of interfaces.
- TemplateInfo - Interface in io.jstach.jstachio
-
Template meta data like its location, formatters, escapers and or its contents.
- TemplateInfo.TemplateSource - Enum Class in io.jstach.jstachio
-
Symbols representing where the template was retrieved from.
- templateMediaType() - Method in interface io.jstach.jstachio.TemplateInfo
-
The template media-type from the
JStacheContentType
. - templateMediaType() - Method in class io.jstach.opt.dropwizard.example.ExampleModelRenderer
- templateMediaType() - Method in class io.jstach.opt.spring.example.hello.HelloModelAndViewView
- templateMediaType() - Method in class io.jstach.opt.spring.example.hello.HelloModelView
- templateMediaType() - Method in class io.jstach.opt.spring.example.message.MessagePageRenderer
- templateMediaType() - Method in class io.jstach.opt.spring.webflux.example.hello.HelloModelView
- templateMediaType() - Method in class io.jstach.opt.spring.webflux.example.message.MessagePageRenderer
- templateModel() - Method in class io.jstach.opt.spring.example.hello.HelloController
-
Here we use the generated code directly and return a
TemplateModel
which is analogous toModelAndView
. - TemplateModel - Interface in io.jstach.jstachio
-
A template and model combined with convenience methods.
- templateName() - Method in interface io.jstach.jstachio.TemplateInfo
-
The logical name of the template which maybe different than
TemplateInfo.templatePath()
. - templateName() - Method in class io.jstach.opt.dropwizard.example.ExampleModelRenderer
- templateName() - Method in class io.jstach.opt.spring.example.hello.HelloModelAndViewView
- templateName() - Method in class io.jstach.opt.spring.example.hello.HelloModelView
- templateName() - Method in class io.jstach.opt.spring.example.message.MessagePageRenderer
- templateName() - Method in class io.jstach.opt.spring.webflux.example.hello.HelloModelView
- templateName() - Method in class io.jstach.opt.spring.webflux.example.message.MessagePageRenderer
- templatePath() - Method in interface io.jstach.jstachio.TemplateInfo
-
If the template is a classpath resource file this will return the location that was originally resolved via config resolution.
- templatePath() - Method in class io.jstach.opt.dropwizard.example.ExampleModelRenderer
- templatePath() - Method in class io.jstach.opt.spring.example.hello.HelloModelAndViewView
- templatePath() - Method in class io.jstach.opt.spring.example.hello.HelloModelView
- templatePath() - Method in class io.jstach.opt.spring.example.message.MessagePageRenderer
- templatePath() - Method in class io.jstach.opt.spring.webflux.example.hello.HelloModelView
- templatePath() - Method in class io.jstach.opt.spring.webflux.example.message.MessagePageRenderer
- TemplateProvider - Interface in io.jstach.jstachio.spi
-
A
ServiceLoader
interface for findingTemplate
s. - TemplateProvider.GeneratedTemplateProvider - Interface in io.jstach.jstachio.spi
-
Generated template providers implement this interface to support easier ServiceLoader registration for modular libraries/applications.
- templates() - Method in interface io.jstach.jstachio.spi.JStachioTemplateFinder.SimpleTemplateFinder
-
Sequence of templates used to find matching template from model.
- templates() - Method in interface io.jstach.jstachio.spi.TemplateProvider.GeneratedTemplateProvider
- Templates - Class in io.jstach.jstachio.spi
-
Locates generated templates by their model via reflection.
- Templates.PathInfo - Interface in io.jstach.jstachio.spi
-
Resolved
JStachePath
config by replacingJStachePath.UNSPECIFIED
with default values. - Templates.TemplateLoadStrategy - Enum Class in io.jstach.jstachio.spi
-
Strategy to load templates dynamically.
- templatesByServiceLoader(TemplateConfig) - Method in class io.jstach.opt.spring.boot.webmvc.JStachioConfiguration
-
Templates found with the service loader
- templateSource() - Method in interface io.jstach.jstachio.TemplateInfo
-
Where the template contents were retrieved from.
- templateString() - Method in interface io.jstach.jstachio.TemplateInfo
-
The raw contents of the template.
- templateString() - Method in class io.jstach.opt.dropwizard.example.ExampleModelRenderer
- templateString() - Method in class io.jstach.opt.spring.example.hello.HelloModelAndViewView
- templateString() - Method in class io.jstach.opt.spring.example.hello.HelloModelView
- templateString() - Method in class io.jstach.opt.spring.example.message.MessagePageRenderer
- templateString() - Method in class io.jstach.opt.spring.webflux.example.hello.HelloModelView
- templateString() - Method in class io.jstach.opt.spring.webflux.example.message.MessagePageRenderer
- ThresholdEncodedOutput<T,
E extends Exception> - Class in io.jstach.jstachio.output -
This abstract output will limit buffering by byte count and then fallback to pushing to the downstream output type of
T
once limit is exceeded. - ThresholdEncodedOutput(Charset, int) - Constructor for class io.jstach.jstachio.output.ThresholdEncodedOutput
-
Create with charset and limit.
- ThresholdEncodedOutput.OutputStreamThresholdEncodedOutput - Class in io.jstach.jstachio.output
-
An OutputStream backed buffer limited encoded output.
- toAppendable() - Method in class io.jstach.jstachio.output.ForwardingOutput
- toAppendable() - Method in interface io.jstach.jstachio.Output
-
Converts the output to an appendable unless it already is one.
- toBuffer() - Method in class io.jstach.jstachio.output.ByteBufferedOutputStream
-
Get a view of the internal byte buffer.
- toByteArray() - Method in interface io.jstach.jstachio.output.BufferedEncodedOutput
-
Copies the output to a byte array.
- toByteArray() - Method in class io.jstach.jstachio.output.ByteBufferedOutputStream
-
Copy internal byte array into a new array.
- toString() - Method in class io.jstach.jstachio.Output.StringOutput
- toString() - Method in record class io.jstach.opt.dropwizard.example.ExampleModel
-
Returns a string representation of this record class.
- toString() - Method in record class io.jstach.opt.spring.example.hello.HelloModel
-
Returns a string representation of this record class.
- toString() - Method in record class io.jstach.opt.spring.example.hello.HelloModelAndView
-
Returns a string representation of this record class.
- toString() - Method in record class io.jstach.opt.spring.webflux.example.hello.HelloModel
-
Returns a string representation of this record class.
- toTemplate(JStachioFilter.FilterChain, TemplateInfo) - Static method in interface io.jstach.jstachio.spi.JStachioFilter.FilterChain
-
Converts the filter chain into a template if it is not already one.
- toView() - Method in interface io.jstach.opt.dropwizard.JStacheViewSupport
-
Creates Dropwizard view from this model
- transferTo(OutputStream) - Method in interface io.jstach.jstachio.output.BufferedEncodedOutput
-
Transfers the entire buffered output by writing to an OutputStream.
- transferTo(OutputStream) - Method in class io.jstach.jstachio.output.ByteBufferedOutputStream
- type() - Element in annotation interface io.jstach.jstache.JStacheConfig
-
Determines what style of of code to generate.
- types() - Element in annotation interface io.jstach.jstache.JStacheFormatterTypes
-
Whitelist classes that will be allowed to be passed to the formatter.
U
- UNSPECIFIED - Enum constant in enum class io.jstach.jstache.JStacheFlags.Flag
-
Flag to indicate nothing is set.
- UNSPECIFIED - Enum constant in enum class io.jstach.jstache.JStacheType
-
This effectively means not set and to let other
JStacheConfig
determine the setting. - UNSPECIFIED - Static variable in annotation interface io.jstach.jstache.JStacheName
-
The value to mean the suffix and prefix is not set.
- UNSPECIFIED - Static variable in annotation interface io.jstach.jstache.JStachePath
-
The value to mean the suffix and prefix is not set.
- use(boolean) - Method in class io.jstach.opt.jmustache.JMustacheRenderer
-
Deprecated.Enables JMustache
- using() - Element in annotation interface io.jstach.jstache.JStacheConfig
-
Imports configuration from another class annotated by this or other JStache annotations.
V
- validateEncoding(TemplateInfo, Output.EncodedOutput<?>) - Static method in class io.jstach.jstachio.spi.Templates
-
A utility method that will check if the templates encoding matches the outputs encoding.
- value() - Element in annotation interface io.jstach.jstache.JStachePartials
-
Multiple partial mappings.
- valueOf(String) - Static method in enum class io.jstach.jstache.JStacheCatalog.CatalogFlag
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.jstach.jstache.JStacheFlags.Flag
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.jstach.jstache.JStacheType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.jstach.jstachio.spi.Templates.TemplateLoadStrategy
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.jstach.jstachio.TemplateInfo.TemplateSource
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.jstach.opt.dropwizard.DropwizardJStacheConfig
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.jstach.opt.spring.SpringJStacheConfig
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.jstach.jstache.JStacheCatalog.CatalogFlag
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.jstach.jstache.JStacheFlags.Flag
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.jstach.jstache.JStacheType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.jstach.jstachio.spi.Templates.TemplateLoadStrategy
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.jstach.jstachio.TemplateInfo.TemplateSource
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.jstach.opt.dropwizard.DropwizardJStacheConfig
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.jstach.opt.spring.SpringJStacheConfig
-
Returns an array containing the constants of this enum class, in the order they are declared.
- view - Variable in class io.jstach.opt.spring.example.hello.HelloController
-
(Optional) Spring will inject this template as the templates are either component scanned or loaded by the ServiceLoader into Spring's context.
- view(T) - Method in interface io.jstach.opt.dropwizard.ViewableTemplate
-
Creates a dropwizard view from the model and this template.
- ViewableTemplate<T> - Interface in io.jstach.opt.dropwizard
-
A mixin for generated templates to create dropwizard views.
- ViewResolvingHandlerInterceptor - Class in io.jstach.opt.spring.webmvc
-
A
HandlerInterceptor
to automatically resolve aController
method return value that is aJStache
model into aJStachioModelView
. - ViewResolvingHandlerInterceptor(JStachio) - Constructor for class io.jstach.opt.spring.webmvc.ViewResolvingHandlerInterceptor
-
Spring will inject jstachio
- ViewSetupBeanPostProcessor - Class in io.jstach.opt.spring.webflux
-
A
BeanPostProcessor
that it registers aHandlerResultHandler
that automatically applies allJStachioModelViewConfigurer
instances to views before rendering. - ViewSetupBeanPostProcessor(ApplicationContext) - Constructor for class io.jstach.opt.spring.webflux.ViewSetupBeanPostProcessor
-
Constructor for Spring to inject the application context.
- viewSetupHandlerInterceptor(ApplicationContext) - Method in class io.jstach.opt.spring.webflux.example.WebConfig
-
Factory to create a bean post processor to register
JStachioModelViewConfigurer
s. - ViewSetupHandlerInterceptor - Class in io.jstach.opt.spring.webmvc
-
A
HandlerInterceptor
that automatically applies allJStachioModelViewConfigurer
instances to views before rendering. - ViewSetupHandlerInterceptor(ApplicationContext) - Constructor for class io.jstach.opt.spring.webmvc.ViewSetupHandlerInterceptor
-
Injected context will be searched for
JStachioModelViewConfigurer
W
- WebConfig - Class in io.jstach.opt.spring.webflux.example
-
Configures WebFlux using
JStachioEncoder
to allow returning models which will be rendered using JStachio runtime. - WebConfig(JStachio) - Constructor for class io.jstach.opt.spring.webflux.example.WebConfig
-
Configures based on the jstachio found by spring
- wired() - Method in class io.jstach.opt.spring.example.hello.HelloController
-
Here we use the wired renderer.
- write(byte[]) - Method in class io.jstach.jstachio.output.ByteBufferedOutputStream
- write(byte[]) - Method in interface io.jstach.jstachio.Output.EncodedOutput
-
Analogous to
OutputStream.write(byte[])
. - write(byte[]) - Method in class io.jstach.jstachio.output.ForwardingEncodedOutput
- write(byte[]) - Method in class io.jstach.jstachio.output.ThresholdEncodedOutput
- write(byte[], int, int) - Method in class io.jstach.jstachio.output.ByteBufferedOutputStream
- write(byte[], int, int) - Method in interface io.jstach.jstachio.Output.EncodedOutput
-
Analogous to
OutputStream.write(byte[], int, int)
. - write(byte[], int, int) - Method in class io.jstach.jstachio.output.ForwardingEncodedOutput
- write(int) - Method in class io.jstach.jstachio.output.ByteBufferedOutputStream
- write(A) - Method in interface io.jstach.jstachio.TemplateModel
-
Renders the passed in model directly to a binary stream possibly leveraging pre-encoded parts of the template.
- write(ExampleModel, A) - Method in class io.jstach.opt.dropwizard.example.ExampleModelRenderer
- write(ExampleModel, ContextNode, A) - Method in class io.jstach.opt.dropwizard.example.ExampleModelRenderer
- write(HelloModelAndView, A) - Method in class io.jstach.opt.spring.example.hello.HelloModelAndViewView
- write(HelloModelAndView, ContextNode, A) - Method in class io.jstach.opt.spring.example.hello.HelloModelAndViewView
- write(HelloModel, A) - Method in class io.jstach.opt.spring.example.hello.HelloModelView
- write(HelloModel, ContextNode, A) - Method in class io.jstach.opt.spring.example.hello.HelloModelView
- write(MessagePage, A) - Method in class io.jstach.opt.spring.example.message.MessagePageRenderer
- write(MessagePage, ContextNode, A) - Method in class io.jstach.opt.spring.example.message.MessagePageRenderer
- write(HelloModel, A) - Method in class io.jstach.opt.spring.webflux.example.hello.HelloModelView
- write(HelloModel, ContextNode, A) - Method in class io.jstach.opt.spring.webflux.example.hello.HelloModelView
- write(MessagePage, A) - Method in class io.jstach.opt.spring.webflux.example.message.MessagePageRenderer
- write(MessagePage, ContextNode, A) - Method in class io.jstach.opt.spring.webflux.example.message.MessagePageRenderer
- write(OutputStream) - Method in interface io.jstach.jstachio.TemplateModel
-
Convenience method to write directly to an outputstream with the templates character encoding.
- write(OutputStream, byte[]) - Method in class io.jstach.jstachio.output.ThresholdEncodedOutput.OutputStreamThresholdEncodedOutput
- write(Object, A) - Method in interface io.jstach.jstachio.JStachio
-
Renders the passed in model directly to a binary stream possibly leveraging pre-encoded parts of the template.
- write(Object, A) - Method in class io.jstach.jstachio.spi.AbstractJStachio
- write(Object, ContextNode, A) - Method in interface io.jstach.jstachio.context.ContextJStachio
-
Renders the passed in model with a context directly to a binary stream leveraging pre-encoded parts of the template.
- write(Object, ContextNode, A) - Method in class io.jstach.jstachio.spi.AbstractJStachio
- write(T, byte[]) - Method in class io.jstach.jstachio.output.ThresholdEncodedOutput
-
Writes to a consumer.
- write(T, A) - Method in interface io.jstach.jstachio.Template.EncodedTemplate
-
Renders the passed in model directly to a binary stream leveraging pre-encoded parts of the template.
- write(T, A) - Method in interface io.jstach.jstachio.Template
-
Renders the passed in model directly to a binary stream possibly leveraging pre-encoded parts of the template.
- write(T, ContextNode, A) - Method in interface io.jstach.jstachio.context.ContextTemplate
-
Renders the passed in model directly to a binary stream leveraging pre-encoded parts of the template.
- write(T, OutputStream) - Method in interface io.jstach.jstachio.Template.EncodedTemplate
-
Renders the passed in model directly to a binary stream leveraging pre-encoded parts of the template.
- write(T, OutputStream) - Method in interface io.jstach.jstachio.Template
-
Renders the passed in model directly to a binary stream using the
TemplateInfo.templateCharset()
for encoding. - writeInternal(Object, HttpOutputMessage) - Method in class io.jstach.opt.spring.web.JStachioHttpMessageConverter
All Classes and Interfaces|All Packages|Constant Field Values