com.github.jknack.handlebars

Class Options

java.lang.Object

com.github.jknack.handlebars.Options

public class Options
extends Object

Options available for Helper.apply(Object, Options). Usage:

   Options options = new Options.Builder(handlebars, context, fn)
      .build();
 

Optionally you can set parameters and hash table:

   Options options = new Options.Builder(handlebars, context, fn)
      .setParams(new Object[] {})
      .setHash(hash)
      .build();
 

Since:

0.1.0

Author:

edgar.espina

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Options.Buffer Buffer like use it to increase rendering time while using helpers.
static class	Options.Builder An Options builder.
static class	Options.InMemoryBuffer A StringBuilder implementation.
static class	Options.NativeBuffer This buffer will write into the underlying writer.

Field Summary

Fields

Modifier and Type	Field and Description
List<String>	blockParams Block param names.
Context	context The current context.
Template	fn The current template.
Handlebars	handlebars The Handlebars object.
Map<String,Object>	hash The hash options.
String	helperName The name of the helper.
Template	inverse The current inverse template.
Object[]	params The parameters.
TagType	tagType The TagType from where the helper was called.

Constructor Summary

Constructors

Constructor and Description
Options(Handlebars handlebars, String helperName, TagType tagType, Context context, Template fn, Template inverse, Object[] params, Map<String,Object> hash, List<String> blockParams) Creates a new Handlebars Options.
Options(Handlebars handlebars, String helperName, TagType tagType, Context context, Template fn, Template inverse, Object[] params, Map<String,Object> hash, List<String> blockParams, Writer writer) Creates a new Handlebars Options.

Method Summary

Methods

Modifier and Type	Method and Description
CharSequence	apply(Template template) Apply the given template to the default context.
CharSequence	apply(Template template, Context context) Apply the given template to the provided context.
CharSequence	apply(Template template, Context context, List<Object> blockParams) Apply the given template to the provided context.
CharSequence	apply(Template template, Object context) Apply the given template to the provided context.
CharSequence	apply(Template template, Object context, List<Object> blockParams) Apply the given template to the provided context.
Options.Buffer	buffer() Get a Buffer which probably increase rendering time (performance).
<T> T	data(String name) Read the attribute from the data storage.
void	data(String name, Object value) Set an attribute in the data storage.
CharSequence	fn() Apply the fn template using the default context.
CharSequence	fn(Context context) Apply the fn template using the provided context.
CharSequence	fn(Object context) Apply the fn template using the provided context.
<T> T	get(String name) Look for a value in the context's stack.
<T> T	get(String name, T defaultValue) Look for a value in the context's stack.
<T> T	hash(String name) Find a value inside the hash attributes.
<T> T	hash(String name, Object defaultValue) Find a value inside the hash attributes.
CharSequence	inverse() Apply the inverse template using the default context.
CharSequence	inverse(Context context) Apply the inverse template using the provided context.
CharSequence	inverse(Object context) Apply the inverse template using the provided context.
boolean	isFalsy(Object value) Returns false if its argument is false, null or empty list/array (a "falsy" value).
<T> T	param(int index) Return a parameter at given index.
<T> T	param(int index, T defaultValue) Return a parameter at given index.
Template	partial(String path) Return a previously registered partial in the current execution context.
void	partial(String path, Template partial) Store a partial in the current execution context.
Set<Map.Entry<String,Object>>	propertySet(Object context) List all the properties and their values for the given object.
Context	wrap(Object model) Creates a Context from the given model.

Methods inherited from class java.lang.Object

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

Field Detail

handlebars

public final Handlebars handlebars

The Handlebars object. Not null.

context

public final Context context

The current context. Not null.

fn

public final Template fn

The current template. Not null.

inverse

public final Template inverse

The current inverse template. Not null.

params

public final Object[] params

The parameters. Not null.

hash

public final Map<String,Object> hash

The hash options. Not null.

tagType

public final TagType tagType

The TagType from where the helper was called.

helperName

public final String helperName

The name of the helper.

blockParams

public final List<String> blockParams

Block param names.

Constructor Detail

Options

public Options(Handlebars handlebars,
       String helperName,
       TagType tagType,
       Context context,
       Template fn,
       Template inverse,
       Object[] params,
       Map<String,Object> hash,
       List<String> blockParams)

Creates a new Handlebars Options.

Parameters:

handlebars - The handlebars instance. Required.

helperName - The name of the helper. Required.

tagType - The TagType from where the helper was called.

context - The current context. Required.

fn - The template function. Required.

inverse - The inverse template function. Required.

params - The parameters. Required.

hash - The optional hash. Required.

blockParams - The block param names. Required.

Options

public Options(Handlebars handlebars,
       String helperName,
       TagType tagType,
       Context context,
       Template fn,
       Template inverse,
       Object[] params,
       Map<String,Object> hash,
       List<String> blockParams,
       Writer writer)

Creates a new Handlebars Options.

Parameters:

handlebars - The handlebars instance. Required.

helperName - The name of the helper. Required.

tagType - The TagType from where the helper was called.

context - The current context. Required.

fn - The template function. Required.

inverse - The inverse template function. Required.

params - The parameters. Required.

hash - The optional hash. Required.

blockParams - The block param names. Required.

writer - A writer. Optional.

Method Detail

fn

public CharSequence fn()
                throws IOException

Apply the fn template using the default context.

Returns:

The resulting text.

Throws:

IOException - If a resource cannot be loaded.

fn

public CharSequence fn(Object context)
                throws IOException

Apply the fn template using the provided context.

Parameters:

context - The context to use.

Returns:

The resulting text.

Throws:

IOException - If a resource cannot be loaded.

fn

public CharSequence fn(Context context)
                throws IOException

Apply the fn template using the provided context.

Parameters:

context - The context to use.

Returns:

The resulting text.

Throws:

IOException - If a resource cannot be loaded.

inverse

public CharSequence inverse()
                     throws IOException

Apply the inverse template using the default context.

Returns:

The resulting text.

Throws:

IOException - If a resource cannot be loaded.

inverse

public CharSequence inverse(Object context)
                     throws IOException

Apply the inverse template using the provided context.

Parameters:

context - The context to use.

Returns:

The resulting text.

Throws:

IOException - If a resource cannot be loaded.

inverse

public CharSequence inverse(Context context)
                     throws IOException

Apply the inverse template using the provided context.

Parameters:

context - The context to use.

Returns:

The resulting text.

Throws:

IOException - If a resource cannot be loaded.

apply

public CharSequence apply(Template template,
                 Object context)
                   throws IOException

Apply the given template to the provided context. The context stack is propagated allowing the access to the whole stack.

Parameters:

template - The template.

context - The context object.

Returns:

The resulting text.

Throws:

IOException - If a resource cannot be loaded.

apply

public CharSequence apply(Template template,
                 Context context)
                   throws IOException

Apply the given template to the provided context. The context stack is propagated allowing the access to the whole stack.

Parameters:

template - The template.

context - The context object.

Returns:

The resulting text.

Throws:

IOException - If a resource cannot be loaded.

apply

public CharSequence apply(Template template,
                 Context context,
                 List<Object> blockParams)
                   throws IOException

Apply the given template to the provided context. The context stack is propagated allowing the access to the whole stack.

Parameters:

template - The template.

context - The context object.

blockParams - The block param values.

Returns:

The resulting text.

Throws:

IOException - If a resource cannot be loaded.

apply

public CharSequence apply(Template template,
                 Object context,
                 List<Object> blockParams)
                   throws IOException

Apply the given template to the provided context. The context stack is propagated allowing the access to the whole stack.

Parameters:

template - The template.

context - The context object.

blockParams - The block param values.

Returns:

The resulting text.

Throws:

IOException - If a resource cannot be loaded.

apply

public CharSequence apply(Template template)
                   throws IOException

Apply the given template to the default context. The context stack is propagated allowing the access to the whole stack.

Parameters:

template - The template.

Returns:

The resulting text.

Throws:

IOException - If a resource cannot be loaded.

param

public <T> T param(int index)

Return a parameter at given index. This is analogous to:

Object param = options.params[index]

The only difference is the type safe feature:

MyType param = options.param(index)

Type Parameters:

T - The runtime type.

Parameters:

index - The parameter position.

Returns:

The paramater's value.

param

public <T> T param(int index,
          T defaultValue)

Return a parameter at given index. This is analogous to:

Object param = options.params[index]

The only difference is the type safe feature:

MyType param = options.param(index)

Type Parameters:

T - The runtime type.

Parameters:

index - The parameter position.

defaultValue - The default value to return if the parameter is not present or if null.

Returns:

The paramater's value.

get

public <T> T get(String name,
        T defaultValue)

Look for a value in the context's stack.

Type Parameters:

T - The runtime type.

Parameters:

name - The property's name.

defaultValue - The default value to return if the attribute is not present or if null.

Returns:

The associated value or null if it's not found.

get

public <T> T get(String name)

Look for a value in the context's stack.

Type Parameters:

T - The runtime type.

Parameters:

name - The property's name.

Returns:

The associated value or null if it's not found.

partial

public Template partial(String path)

Return a previously registered partial in the current execution context.

Parameters:

path - The partial's path. Required.

Returns:

A previously registered partial in the current execution context. Or null if not found.

partial

public void partial(String path,
           Template partial)

Store a partial in the current execution context.

Parameters:

path - The partial's path. Required.

partial - The partial template. Required.

hash

public <T> T hash(String name)

Find a value inside the hash attributes. This is analogous to:

Object myClass = options.hash.get("class");

This mehtod works as a shorthand and type safe call:

String myClass = options.hash("class");

Type Parameters:

T - The runtime type.

Parameters:

name - The hash's name.

Returns:

The hash value or null.

hash

public <T> T hash(String name,
         Object defaultValue)

Find a value inside the hash attributes. This is analogous to:

Object myClass = options.hash.get("class");

This method works as a shorthand and type safe call:

String myClass = options.hash("class");

Type Parameters:

T - The runtime type.

Parameters:

name - The hash's name.

defaultValue - The default value to returns.

Returns:

The hash value or null.

isFalsy

public boolean isFalsy(Object value)

Returns false if its argument is false, null or empty list/array (a "falsy" value).

Parameters:

value - A value.

Returns:

False if its argument is false, null or empty list/array (a "falsy" value).

wrap

public Context wrap(Object model)

Creates a Context from the given model. If the object is a context already the same object will be returned.

Parameters:

model - The model object.

Returns:

A context representing the model or the same model if it's a context already.

data

public <T> T data(String name)

Read the attribute from the data storage.

Type Parameters:

T - Data type.

Parameters:

name - The attribute's name.

Returns:

The attribute value or null.

data

public void data(String name,
        Object value)

Set an attribute in the data storage.

Parameters:

name - The attribute's name. Required.

value - The attribute's value. Required.

propertySet

public Set<Map.Entry<String,Object>> propertySet(Object context)

List all the properties and their values for the given object.

Parameters:

context - The context object. Not null.

Returns:

All the properties and their values for the given object.

buffer

public Options.Buffer buffer()

Get a Buffer which probably increase rendering time (performance). Usage:

 public CharSequence helper(Object ctx, Options options) {
   Buffer buffer = options.buffer();
   ...
   buffer.append(...);
   ...
   return buffer;
 }
 

Something to keep in mind is that when using the native buffer there won't be any visible output. For example Options.NativeBuffer.toString() results in an empty string, that's expected because the content is written directly to the underlying writer.

Returns:

A new buffer.