Index (jstachio 1.3.6 API)

A B C D E F G H I J L M N O P R S T V W
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.
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 calling Formatter.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

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 a ReadableByteChannel.
bufferSizeHint() - Method in interface io.jstach.jstachio.output.BufferedEncodedOutput: The recommend buffer size to use for extracting with BufferedEncodedOutput.asReadableByteChannel() or BufferedEncodedOutput.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 from JStachioExtensions.
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.
charset - Variable in class io.jstach.jstachio.output.ByteBufferedOutputStream: The expected charset of the output.
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
ChunkEncodedOutput<T> - Interface in io.jstach.jstachio.output: Maintains the encoded output in an iterable of chunks of type T that is optimized for BufferedEncodedOutput.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.
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
context() - Method in interface io.jstach.jstachio.context.ContextSupplier: A context node never null but maybe empty.
CONTEXT_BINDING_NAME - Static variable in interface io.jstach.jstachio.context.ContextNode: The default binding name in mustache for the context parameter.
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.

D

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.
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.

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.
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.
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(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, 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.

F

filter(TemplateInfo, JStachioFilter.FilterChain) - Method in interface io.jstach.jstachio.spi.JStachioFilter: Advises or filters a previously created filter.
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 a TemplateInfo 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 a TemplateInfo 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 a TemplateInfo 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.
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() - 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: Do nothing constructor
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: Do nothing constructor

G

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: See Boolean.getBoolean(String).
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.
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.
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 to JStachioExtensions.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 is false.
getPathInfo(Class<?>) - Static method in class io.jstach.jstachio.spi.Templates: INTERNAL (use at your own risk): Resolved JStachePath config by replacing JStachePath.UNSPECIFIED with default values.
getProperty(String) - Method in interface io.jstach.jstachio.spi.JStachioConfig: Gets a property from some config implementation.
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

Html - Class in io.jstach.jstachio.escapers: Provides a mustache spec based HTML escaper which is the default in normal mustache.

I

init(JStachioConfig) - Method in interface io.jstach.jstachio.spi.JStachioExtensionProvider: Called before the extensions are used but after JStachioExtensionProvider.provideConfig().
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.
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 boolean false are falsey however empty Map is not falsey but ContextNode.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 boolean false are falsey however empty Map is not falsey.
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

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.
JStachioConfig - Interface in io.jstach.jstachio.spi: Runtime Config Service.
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 JStachioExtensions 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 a JStachioFactory.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.
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.

L

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.
LOGGING_DISABLE - Static variable in interface io.jstach.jstachio.spi.JStachioConfig: Config key to disable logging.

M

model() - Method in interface io.jstach.jstachio.TemplateModel: Model.
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.

N

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).

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: Do nothing constructor
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 with JStachioExtension as the SPI.
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 an Output.EncodedOutput.
of(OutputStream, Charset) - Static method in interface io.jstach.jstachio.Output: Adapts an OutputStream as an Output.
of(Appendable) - Static method in interface io.jstach.jstachio.Output: Adapts an Appendable as an Output.
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(StringBuilder) - Static method in interface io.jstach.jstachio.Output: Adapts a StringBuilder as an Output.
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 and DataOutput.
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
PlainText - Class in io.jstach.jstachio.escapers: Provides NOOP escaper for working with plain text.
prefix() - Method in interface io.jstach.jstachio.spi.Templates.PathInfo: Resolved prefix.
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.
provideFilter() - Method in interface io.jstach.jstachio.spi.JStachioExtensionProvider: 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.
provideTemplateFinder() - Method in interface io.jstach.jstachio.spi.JStachioExtensionProvider: 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.

R

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(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).
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 is JStachePath.UNSPECIFIED.
resolvePath(Class<?>) - Static method in class io.jstach.jstachio.spi.Templates: Deprecated.
use Templates.getInfoByReflection(Class) or Templates.getPathInfo(Class).
RESOURCE - Enum constant in enum class io.jstach.jstachio.TemplateInfo.TemplateSource: Template was retrieved from the classpath at compile time.

S

SERVICE_LOADER - Enum constant in enum class io.jstach.jstachio.spi.Templates.TemplateLoadStrategy: Strategy that will try the ServiceLoader with the SPI of TemplateProvider.
SERVICELOADER_TEMPLATE_DISABLE - Static variable in interface io.jstach.jstachio.spi.JStachioConfig: Config key to disable service loader based lookup of templates.
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.
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).
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() - Method in interface io.jstach.jstachio.spi.Templates.PathInfo: Resolved suffix.
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.

T

template() - Method in interface io.jstach.jstachio.TemplateModel: Template.
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.
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.
TemplateConfig - Interface in io.jstach.jstachio: A Container for optional template collaborators for ease of wiring generated Templates.
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.
templateEscaper() - Method in interface io.jstach.jstachio.TemplateInfo: The escaper to be used on the template.
templateFormatter() - Method in interface io.jstach.jstachio.TemplateInfo: The base formatter to be used on the template.
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.
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().
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.
TemplateProvider - Interface in io.jstach.jstachio.spi: A ServiceLoader interface for finding Templates.
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 replacing JStachePath.UNSPECIFIED with default values.
Templates.TemplateLoadStrategy - Enum Class in io.jstach.jstachio.spi: Strategy to load templates dynamically.
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.
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
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.
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

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.
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.
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.

W

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(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.

A B C D E F G H I J L M N O P R S T V W
All Classes and Interfaces|All Packages|Constant Field Values