SpincastTemplatingRequestContextAddon (org.spincast:spincast-framework 0.9.17 API)

java.lang.Object
- org.spincast.plugins.templatingaddon.SpincastTemplatingRequestContextAddon<R>

All Implemented Interfaces:: ITemplatingRequestContextAddon<R>

public class SpincastTemplatingRequestContextAddon<R extends IRequestContext<?>>
extends Object
implements ITemplatingRequestContextAddon<R>

Constructor Summary

Constructors
Constructor and Description
`SpincastTemplatingRequestContextAddon(R requestContext, ITemplatingEngine templatingEngine, ILocaleResolver localeResolver)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTemplatingGlobalVariable(String key, Object value)` Adds a global variable that will be available to any following evaluation by the templating engine.
`void`	`addTemplatingGlobalVariables(Map<String,Object> variables)` Adds global variables that will be available to any following evaluation by the templating engine.
`String`	`createPlaceholder(String variable)` Creates a placeholder using the current templating engine implementation.
`void`	`deleteAllTemplatingGlobalVariables()` Deletes all global templating variables.
`void`	`deleteTemplatingGlobalVariable(String key)` Deletes a global templating variable.
`String`	`evaluate(String content, Map<String,Object> params)` Evaluates some content using the given parameters.
`String`	`evaluate(String content, Map<String,Object> params, Locale locale)` Evaluates some content using the given parameters.
`String`	`fromTemplate(String templatePath, boolean isClasspathPath, Map<String,Object> params)` Renders a template using the given parameters.
`String`	`fromTemplate(String templatePath, boolean isClasspathPath, Map<String,Object> params, Locale locale)` Renders a template usgin the given parameters.
`String`	`fromTemplate(String templatePath, Map<String,Object> params)` Renders a template using the given parameters.
`String`	`fromTemplate(String templatePath, Map<String,Object> params, Locale locale)` Renders a template usgin the given parameters.
`protected ILocaleResolver`	`getLocaleResolver()`
`protected Locale`	`getLocaleToUse()`
`protected R`	`getRequestContext()`
`protected ITemplatingEngine`	`getTemplatingEngine()`
`Object`	`getTemplatingGlobalVariable(String key)` Gets a global templating variable.
`Map<String,Object>`	`getTemplatingGlobalVariables()` The global templating variables.

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

- Constructor Detail
  - SpincastTemplatingRequestContextAddon
```
@Inject
public SpincastTemplatingRequestContextAddon(R requestContext,
                                                      ITemplatingEngine templatingEngine,
                                                      ILocaleResolver localeResolver)
```
- Method Detail
  - getRequestContext
```
protected R getRequestContext()
```
  - getTemplatingEngine
```
protected ITemplatingEngine getTemplatingEngine()
```
  - getLocaleResolver
```
protected ILocaleResolver getLocaleResolver()
```
  - getLocaleToUse
```
protected Locale getLocaleToUse()
```
  - getTemplatingGlobalVariables
```
public Map<String,Object> getTemplatingGlobalVariables()
```
    Description copied from interface: ITemplatingRequestContextAddon
    
    The global templating variables.
    
    Specified by:
    
    getTemplatingGlobalVariables in interface ITemplatingRequestContextAddon<R extends IRequestContext<?>>
  - evaluate
```
public String evaluate(String content,
                       Map<String,Object> params)
```
    Description copied from interface: ITemplatingRequestContextAddon
    
    Evaluates some content using the given parameters. Uses the Locale found by the LocaleResolver.
    
    Specified by:
    
    evaluate in interface ITemplatingRequestContextAddon<R extends IRequestContext<?>>
  - evaluate
```
public String evaluate(String content,
                       Map<String,Object> params,
                       Locale locale)
```
    Description copied from interface: ITemplatingRequestContextAddon
    
    Evaluates some content using the given parameters. Uses the specified Locale.
    
    Specified by:
    
    evaluate in interface ITemplatingRequestContextAddon<R extends IRequestContext<?>>
  - fromTemplate
```
public String fromTemplate(String templatePath,
                           Map<String,Object> params)
```
    Description copied from interface: ITemplatingRequestContextAddon
    
    Renders a template using the given parameters. Uses the Locale found by the LocaleResolver.
    
    Specified by:
    
    fromTemplate in interface ITemplatingRequestContextAddon<R extends IRequestContext<?>>
    
    Parameters:
    
    templatePath - must be a classpath's relative path.
  - fromTemplate
```
public String fromTemplate(String templatePath,
                           boolean isClasspathPath,
                           Map<String,Object> params)
```
    Description copied from interface: ITemplatingRequestContextAddon
    
    Renders a template using the given parameters. Uses the Locale found by the LocaleResolver.
    
    Specified by:
    
    fromTemplate in interface ITemplatingRequestContextAddon<R extends IRequestContext<?>>
    
    isClasspathPath - if true, the 'templatePath' is considered as a classpath's relative path. If false, it is considered as an absolute file system path.
  - fromTemplate
```
public String fromTemplate(String templatePath,
                           Map<String,Object> params,
                           Locale locale)
```
    Description copied from interface: ITemplatingRequestContextAddon
    
    Renders a template usgin the given parameters. Uses the Locale specified.
    
    Specified by:
    
    fromTemplate in interface ITemplatingRequestContextAddon<R extends IRequestContext<?>>
    
    Parameters:
    
    templatePath - must be a classpath's relative path.
  - fromTemplate
```
public String fromTemplate(String templatePath,
                           boolean isClasspathPath,
                           Map<String,Object> params,
                           Locale locale)
```
    Description copied from interface: ITemplatingRequestContextAddon
    
    Renders a template usgin the given parameters. Uses the Locale specified.
    
    Specified by:
    
    fromTemplate in interface ITemplatingRequestContextAddon<R extends IRequestContext<?>>
    
    isClasspathPath - if true, the 'templatePath' is considered as a classpath's relative path. If false, it is considered as an absolute file system path.
  - addTemplatingGlobalVariable
```
public void addTemplatingGlobalVariable(String key,
                                        Object value)
```
    Description copied from interface: ITemplatingRequestContextAddon
    
    Adds a global variable that will be available to any following evaluation by the templating engine.
    
    Specified by:
    
    addTemplatingGlobalVariable in interface ITemplatingRequestContextAddon<R extends IRequestContext<?>>
  - addTemplatingGlobalVariables
```
public void addTemplatingGlobalVariables(Map<String,Object> variables)
```
    Description copied from interface: ITemplatingRequestContextAddon
    
    Adds global variables that will be available to any following evaluation by the templating engine.
    
    Specified by:
    
    addTemplatingGlobalVariables in interface ITemplatingRequestContextAddon<R extends IRequestContext<?>>
  - getTemplatingGlobalVariable
```
public Object getTemplatingGlobalVariable(String key)
```
    Description copied from interface: ITemplatingRequestContextAddon
    
    Gets a global templating variable.
    
    Specified by:
    
    getTemplatingGlobalVariable in interface ITemplatingRequestContextAddon<R extends IRequestContext<?>>
  - deleteAllTemplatingGlobalVariables
```
public void deleteAllTemplatingGlobalVariables()
```
    Description copied from interface: ITemplatingRequestContextAddon
    
    Deletes all global templating variables.
    
    Specified by:
    
    deleteAllTemplatingGlobalVariables in interface ITemplatingRequestContextAddon<R extends IRequestContext<?>>
  - deleteTemplatingGlobalVariable
```
public void deleteTemplatingGlobalVariable(String key)
```
    Description copied from interface: ITemplatingRequestContextAddon
    
    Deletes a global templating variable.
    
    Specified by:
    
    deleteTemplatingGlobalVariable in interface ITemplatingRequestContextAddon<R extends IRequestContext<?>>
  - createPlaceholder
```
public String createPlaceholder(String variable)
```
    Description copied from interface: ITemplatingRequestContextAddon
    
    Creates a placeholder using the current templating engine implementation.
    This is mainly useful for the tests, which don't know in advance which templating engine will be used, so which syntax to use for the placeholders.
    
    For example, using Pebble, a call to createPlaceholder("name") will result in "{{name}}" (without the quotes).
    
    Specified by:
    
    createPlaceholder in interface ITemplatingRequestContextAddon<R extends IRequestContext<?>>

Class SpincastTemplatingRequestContextAddon<R extends IRequestContext<?>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SpincastTemplatingRequestContextAddon

Method Detail

getRequestContext

getTemplatingEngine

getLocaleResolver

getLocaleToUse

getTemplatingGlobalVariables

evaluate

evaluate

fromTemplate

fromTemplate

fromTemplate

fromTemplate

addTemplatingGlobalVariable

addTemplatingGlobalVariables

getTemplatingGlobalVariable

deleteAllTemplatingGlobalVariables

deleteTemplatingGlobalVariable

createPlaceholder