BlockDecorator (Handlebars 4.0.6 API)

java.lang.Object
- com.github.jknack.handlebars.internal.BlockDecorator

All Implemented Interfaces:

Template
```
public class BlockDecorator
extends Object
```
A block decorator implementation.

Since:

4.0.0

Author:

edgar

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<String>`	`blockParams` Block param names.
`protected Template`	`body` The body template.
`protected int`	`column` The column of this template.
`protected String`	`filename` The file's name.
`protected Handlebars`	`handlebars` The handlebars object.
`protected Map<String,Param>`	`hash` The hash object.
`protected int`	`hashSize` Hash's size.
`protected Helper<Object>`	`helper` Helper.
`protected Template`	`inverse` Inverse section for if/else clauses.
`protected int`	`line` The line of this template.
`protected String`	`name` The section's name.
`protected List<Param>`	`params` The parameter list.
`protected int`	`paramSize` Param's size.
`protected List<PathExpression>`	`path` Compiled path for `name()`.
`protected TagType`	`tagType` Tag type, default: is `TagType.SECTION`.

Fields inherited from interface com.github.jknack.handlebars.Template
EMPTY

Constructor Summary

Constructors
Constructor and Description
`BlockDecorator(Handlebars handlebars, String name, boolean inverted, List<Param> params, Map<String,Param> hash, List<String> blockParams, boolean root)` Creates a new `BlockDecorator`.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`after(Context context, Writer writer)` Notify that template has been processed.
`String`	`apply(Context context)` Merge the template tree using the given context.
`void`	`apply(Context context, Writer writer)` Merge the template tree using the given context.
`String`	`apply(Object context)` Merge the template tree using the given context.
`void`	`apply(Object context, Writer writer)` Merge the template tree using the given context.
`<T> TypeSafeTemplate<T>`	`as()` Creates a new `TypeSafeTemplate`.
`<T,S extends TypeSafeTemplate<T>> S`	`as(Class<S> rootType)` Creates a new `TypeSafeTemplate`.
`void`	`before(Context context, Writer writer)` Notify that template is going to be processed.
`Template`	`body()` The template's body.
`com.github.jknack.handlebars.internal.Block`	`body(Template body)` Set the template body.
`protected void`	`collect(Collection<String> result, TagType tagType)` Child classes might want to check if they apply to the tagtype and append them self to the result list.
`List<String>`	`collect(TagType... tagType)` Collect all the tag names under the given tagType.
`List<String>`	`collectReferenceParameters()` Collects all the parameters which are also variables.
`protected void`	`collectReferenceParameters(Collection<String> result)`
`protected Object[]`	`decoParams(Context ctx)` Build a parameter list by looking for values in the current context.
`boolean`	`decorate()`
`protected Object`	`determineContext(Context context)` Determine the current context.
`String`	`endDelimiter()` The end delimiter.
`com.github.jknack.handlebars.internal.Block`	`endDelimiter(String endDelimiter)` Set the end delimiter.
`String`	`filename()`
`com.github.jknack.handlebars.internal.BaseTemplate`	`filename(String filename)` Set the file's name.
`protected Map<String,Object>`	`hash(Context context)` Build a hash object by looking for values in the current context.
`com.github.jknack.handlebars.internal.HelperResolver`	`hash(Map<String,Param> hash)` Set the hash.
`protected String`	`hashToString()` Make a string of `hash`.
`protected Helper<Object>`	`helper(String name)` Find the helper by it's name.
`Template`	`inverse()` The inverse template for else clauses.
`Template`	`inverse(String inverseLabel, Template inverse)` Set the inverse template.
`boolean`	`inverted()` True if it's an inverted section.
`protected void`	`merge(Context context, Writer writer)` Merge a child template into the writer.
`String`	`name()` The section's name.
`protected Object[]`	`params(Context ctx)` Build a parameter list by looking for values in the current context.
`com.github.jknack.handlebars.internal.HelperResolver`	`params(List<Param> params)` Set the parameters.
`protected String`	`paramsToString(List<?> params)` Make a string of `params`.
`int[]`	`position()`
`com.github.jknack.handlebars.internal.BaseTemplate`	`position(int line, int column)` Set the template position.
`protected void`	`postInit()` Make/run any pending or required initialization.
`String`	`startDelimiter()` The start delimiter.
`com.github.jknack.handlebars.internal.Block`	`startDelimiter(String startDelimiter)` Set the start delimiter.
`String`	`text()` Provide the raw text.
`String`	`toJavaScript()` Convert this template to JavaScript template (a.k.a precompiled template).
`String`	`toString()`
`static Object`	`transform(Object candidate)` Transform the given value into something different or leave it as it is.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - body
```
protected Template body
```
    The body template.
  - name
```
protected final String name
```
    The section's name.
  - inverse
```
protected Template inverse
```
    Inverse section for if/else clauses.
  - helper
```
protected Helper<Object> helper
```
    Helper.
  - blockParams
```
protected final List<String> blockParams
```
    Block param names.
  - tagType
```
protected TagType tagType
```
    Tag type, default: is TagType.SECTION.
  - path
```
protected final List<PathExpression> path
```
    Compiled path for name().
  - params
```
protected List<Param> params
```
    The parameter list.
  - hash
```
protected Map<String,Param> hash
```
    The hash object.
  - paramSize
```
protected int paramSize
```
    Param's size.
  - hashSize
```
protected int hashSize
```
    Hash's size.
  - handlebars
```
protected final Handlebars handlebars
```
    The handlebars object. Required.
  - line
```
protected int line
```
    The line of this template.
  - column
```
protected int column
```
    The column of this template.
  - filename
```
protected String filename
```
    The file's name.
- Constructor Detail
  - BlockDecorator
```
public BlockDecorator(Handlebars handlebars,
              String name,
              boolean inverted,
              List<Param> params,
              Map<String,Param> hash,
              List<String> blockParams,
              boolean root)
```
    Creates a new BlockDecorator.
    
    Parameters:
    handlebars - The handlebars object.
    name - The section's name.
    inverted - True if it's inverted.
    params - The parameter list.
    hash - The hash.
    blockParams - The block param names.
    root - True, if this is top level decorator.
- Method Detail
  - postInit
```
protected void postInit()
```
    Make/run any pending or required initialization.
  - before
```
public void before(Context context,
          Writer writer)
            throws IOException
```
    Notify that template is going to be processed.
    
    Parameters:
    context - The context object. Required.
    writer - The writer object. Required.
    
    Throws:
    
    IOException - If a resource cannot be loaded.
  - apply
```
public void apply(Context context,
         Writer writer)
           throws IOException
```
    Description copied from interface: Template
    
    Merge the template tree using the given context.
    
    Specified by:
    
    apply in interface Template
    
    Parameters:
    context - The context object. Required.
    writer - The writer object. Required.
    
    Throws:
    
    IOException - If a resource cannot be loaded.
  - after
```
public void after(Context context,
         Writer writer)
           throws IOException
```
    Notify that template has been processed.
    
    Parameters:
    context - The context object. Required.
    writer - The writer object. Required.
    
    Throws:
    
    IOException - If a resource cannot be loaded.
  - decorate
```
public boolean decorate()
```
    Returns:
    True if this template has decorators.
  - merge
```
protected void merge(Context context,
         Writer writer)
              throws IOException
```
    Merge a child template into the writer.
    
    Parameters:
    context - The scope object.
    writer - The writer.
    
    Throws:
    
    IOException - If a resource cannot be loaded.
  - name
```
public String name()
```
    The section's name.
    
    Returns:
    The section's name.
  - inverted
```
public boolean inverted()
```
    True if it's an inverted section.
    
    Returns:
    True if it's an inverted section.
  - body
```
public com.github.jknack.handlebars.internal.Block body(Template body)
```
    Set the template body.
    
    Parameters:
    body - The template body. Required.
    
    Returns:
    This section.
  - inverse
```
public Template inverse(String inverseLabel,
               Template inverse)
```
    Set the inverse template.
    
    Parameters:
    inverseLabel - One of 'else' or '^'. Required.
    inverse - The inverse template. Required.
    
    Returns:
    This section.
  - inverse
```
public Template inverse()
```
    The inverse template for else clauses.
    
    Returns:
    The inverse template for else clauses.
  - endDelimiter
```
public com.github.jknack.handlebars.internal.Block endDelimiter(String endDelimiter)
```
    Set the end delimiter.
    
    Parameters:
    endDelimiter - The end delimiter.
    
    Returns:
    This section.
  - startDelimiter
```
public com.github.jknack.handlebars.internal.Block startDelimiter(String startDelimiter)
```
    Set the start delimiter.
    
    Parameters:
    startDelimiter - The start delimiter.
    
    Returns:
    This section.
  - body
```
public Template body()
```
    The template's body.
    
    Returns:
    The template's body.
  - text
```
public String text()
```
    Description copied from interface: Template
    
    Provide the raw text.
    
    Returns:
    The raw text.
  - startDelimiter
```
public String startDelimiter()
```
    The start delimiter.
    
    Returns:
    The start delimiter.
  - endDelimiter
```
public String endDelimiter()
```
    The end delimiter.
    
    Returns:
    The end delimiter.
  - collect
```
public List<String> collect(TagType... tagType)
```
    Description copied from interface: Template
    Collect all the tag names under the given tagType.
    Usage:
```
 {{hello}}
 {{var 1}}
 {{{tripleVar}}}
 
```
    collect(TagType.VAR) returns [hello, var]
    
    collect(TagType.TRIPLE_VAR) returns [tripleVar]
    
    collect(TagType.VAR, TagType.TRIPLE_VAR) returns [hello, var, tripleVar]
    Specified by:
    
    collect in interface Template
    
    Parameters:
    tagType - The tag type. Required.
    
    Returns:
    A list with tag names.
  - collect
```
protected void collect(Collection<String> result,
           TagType tagType)
```
    Child classes might want to check if they apply to the tagtype and append them self to the result list.
    
    Parameters:
    result - The result list.
    tagType - The matching tagtype.
  - collectReferenceParameters
```
public List<String> collectReferenceParameters()
```
    Description copied from interface: Template
    Collects all the parameters which are also variables.
    Usage:
```
 {{#if v1}}{{/if}}
 {{#each v2 "test"}}{{/each}}
 
```
    collectReferenceParameters() returns [v1, v2]
    Specified by:
    
    collectReferenceParameters in interface Template
    
    Returns:
    A list with reference parameter names.
  - hash
```
protected Map<String,Object> hash(Context context)
                           throws IOException
```
    Build a hash object by looking for values in the current context.
    
    Parameters:
    context - The current context.
    
    Returns:
    A hash object with values in the current context.
    
    Throws:
    
    IOException - If param can't be applied.
  - params
```
protected Object[] params(Context ctx)
                   throws IOException
```
    Build a parameter list by looking for values in the current context.
    
    Parameters:
    ctx - The current context.
    
    Returns:
    A parameter list with values in the current context.
    
    Throws:
    
    IOException - If param can't be applied.
  - decoParams
```
protected Object[] decoParams(Context ctx)
                       throws IOException
```
    Build a parameter list by looking for values in the current context.
    
    Parameters:
    ctx - The current context.
    
    Returns:
    A parameter list with values in the current context.
    
    Throws:
    
    IOException - If param can't be applied.
  - determineContext
```
protected Object determineContext(Context context)
                           throws IOException
```
    Determine the current context. If the param list is empty, the current context value is returned.
    
    Parameters:
    context - The current context.
    
    Returns:
    The current context.
    
    Throws:
    
    IOException - If param can't be applied.
  - transform
```
public static final Object transform(Object candidate)
```
    Transform the given value into something different or leave it as it is.
    
    Parameters:
    candidate - The candidate value. May be null.
    
    Returns:
    A transformed value or the original value.
  - helper
```
protected Helper<Object> helper(String name)
```
    Find the helper by it's name.
    
    Parameters:
    name - The helper's name.
    
    Returns:
    The matching helper.
  - hash
```
public com.github.jknack.handlebars.internal.HelperResolver hash(Map<String,Param> hash)
```
    Set the hash.
    
    Parameters:
    hash - The new hash.
    
    Returns:
    This resolver.
  - params
```
public com.github.jknack.handlebars.internal.HelperResolver params(List<Param> params)
```
    Set the parameters.
    
    Parameters:
    params - The new params.
    
    Returns:
    This resolver.
  - paramsToString
```
protected String paramsToString(List<?> params)
```
    Make a string of params.
    
    Parameters:
    params - list of params.
    
    Returns:
    Make a string of params.
  - hashToString
```
protected String hashToString()
```
    Make a string of hash.
    
    Returns:
    Make a string of hash.
  - collectReferenceParameters
```
protected void collectReferenceParameters(Collection<String> result)
```
    Parameters:
    result - The result list to add new parameters to.
  - apply
```
public final String apply(Object context)
                   throws IOException
```
    Merge the template tree using the given context.
    
    Specified by:
    
    apply in interface Template
    
    Parameters:
    context - The context object. May be null.
    
    Returns:
    The resulting template.
    
    Throws:
    
    IOException - If a resource cannot be loaded.
  - apply
```
public final void apply(Object context,
         Writer writer)
                 throws IOException
```
    Merge the template tree using the given context.
    
    Specified by:
    
    apply in interface Template
    
    Parameters:
    context - The context object. May be null.
    writer - The writer object. Required.
    
    Throws:
    
    IOException - If a resource cannot be loaded.
  - apply
```
public String apply(Context context)
             throws IOException
```
    Description copied from interface: Template
    
    Merge the template tree using the given context.
    
    Specified by:
    
    apply in interface Template
    
    Parameters:
    context - The context object. Required.
    
    Returns:
    The resulting template.
    
    Throws:
    
    IOException - If a resource cannot be loaded.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - filename
```
public com.github.jknack.handlebars.internal.BaseTemplate filename(String filename)
```
    Set the file's name.
    
    Parameters:
    filename - The file's name.
    
    Returns:
    This template.
  - filename
```
public String filename()
```
    Specified by:
    
    filename in interface Template
    
    Returns:
    The template file's name.
  - position
```
public int[] position()
```
    Specified by:
    
    position in interface Template
    
    Returns:
    The line and column where the template was found.
  - position
```
public com.github.jknack.handlebars.internal.BaseTemplate position(int line,
                                                          int column)
```
    Set the template position.
    
    Parameters:
    line - The line.
    column - The column.
    
    Returns:
    This template.
  - as
```
public <T,S extends TypeSafeTemplate<T>> S as(Class<S> rootType)
```
    Description copied from interface: Template
    
    Creates a new TypeSafeTemplate.
    
    Specified by:
    
    as in interface Template
    
    Type Parameters:
    T - The root type.
    S - The template type.
    Parameters:
    rootType - The template type. Required.
    
    Returns:
    A new TypeSafeTemplate.
  - as
```
public <T> TypeSafeTemplate<T> as()
```
    Description copied from interface: Template
    
    Creates a new TypeSafeTemplate.
    
    Specified by:
    
    as in interface Template
    
    Type Parameters:
    T - The root type.
    
    Returns:
    A new TypeSafeTemplate.
  - toJavaScript
```
public String toJavaScript()
```
    Description copied from interface: Template
    
    Convert this template to JavaScript template (a.k.a precompiled template). Compilation is done by handlebars.js and a JS Engine (usually Rhino).
    
    Specified by:
    
    toJavaScript in interface Template
    
    Returns:
    A pre-compiled JavaScript version of this template.

Class BlockDecorator

Field Summary

Fields inherited from interface com.github.jknack.handlebars.Template

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

body

name

inverse

helper

blockParams

tagType

path

params

hash

paramSize

hashSize

handlebars

line

column

filename

Constructor Detail

BlockDecorator

Method Detail

postInit

before

apply

after

decorate

merge

name

inverted

body

inverse

inverse

endDelimiter

startDelimiter

body

text

startDelimiter

endDelimiter

collect

collect

collectReferenceParameters

hash

params

decoParams

determineContext

transform

helper

hash

params

paramsToString

hashToString

collectReferenceParameters

apply

apply

apply

toString

filename

filename

position

position

as

as

toJavaScript