org.jooby.pebble

Class Pebble

java.lang.Object

org.jooby.pebble.Pebble

All Implemented Interfaces:

Jooby.Module

public class Pebble
extends Object
implements Jooby.Module

pebble

Pebble a lightweight but rock solid Java templating engine.

usage

 {
   use(new Pebble());

   get("/", req  -> Results.html("index").put("model", new MyModel());

   // or Pebble API
   get("/pebble-api", req  -> {
     PebbleEngine pebble = req.require(PebbleEngine.class);
     PebbleTemplate template = pebble.getTemplate("template");
     template.evaluate(...);
   });
 }
 

Templates are loaded from root of classpath: / and must end with: .html file extension.

template loader

Templates are loaded from the root of classpath and must end with .html. You can change the default template location and extensions too:

 {
   use(new Pebble("templates", ".pebble"));
 }
 

template cache

Cache is OFF when env=dev (useful for template reloading), otherwise is ON.

Cache is backed by Guava and the default cache will expire after 200 entries.

If 200 entries is not enough or you need a more advanced cache setting, just set the pebble.cache option:

 pebble.cache = "expireAfterWrite=1h;maximumSize=200"
 

See CacheBuilderSpec.

tag cache

It works like template cache, except the cache is controlled by the property: pebble.tagCache

advanced configuration

Advanced configuration if provided by callback:

 {
   use(new Pebble().doWith(pebble  -> {
     pebble.extension(...);
     pebble.loader(...);
   }));
 }
 

That's all folks! Enjoy it!!!

Since:

0.13.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
Pebble() Creates a new Pebble module.
Pebble(String suffix) Creates a new Pebble module.
Pebble(String prefix, String suffix) Creates a new Pebble module.

Method Summary

Modifier and Type	Method and Description
com.typesafe.config.Config	config()
void	configure(Env env, com.typesafe.config.Config conf, com.google.inject.Binder binder)
Pebble	doWith(BiConsumer<com.mitchellbosecke.pebble.PebbleEngine.Builder,com.typesafe.config.Config> callback) Advanced configuration callback for PebbleEngine.Builder.
Pebble	doWith(Consumer<com.mitchellbosecke.pebble.PebbleEngine.Builder> callback) Advanced configuration callback for PebbleEngine.Builder.

Methods inherited from class java.lang.Object

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

Constructor Detail

Pebble

public Pebble(String prefix,
              String suffix)

Creates a new Pebble module. Add a ClasspathLoader and set prefix and suffix on it.

Parameters:

prefix - Template prefix location (might be null).

suffix - Template extension.

Pebble

public Pebble(String suffix)

Creates a new Pebble module. Add a ClasspathLoader that loads template from root of classpath and ends with the given suffix.

Parameters:

suffix - Template extension.

Pebble

public Pebble()

Creates a new Pebble module. Add a ClasspathLoader that loads template from root of classpath and ends with the given .html.

Method Detail

doWith

public Pebble doWith(BiConsumer<com.mitchellbosecke.pebble.PebbleEngine.Builder,com.typesafe.config.Config> callback)

Advanced configuration callback for PebbleEngine.Builder.

Parameters:

callback - A callback to finish setup.

Returns:

This module.

doWith

public Pebble doWith(Consumer<com.mitchellbosecke.pebble.PebbleEngine.Builder> callback)

Advanced configuration callback for PebbleEngine.Builder.

Parameters:

callback - A callback to finish setup.

Returns:

This module.

configure

public void configure(Env env,
                      com.typesafe.config.Config conf,
                      com.google.inject.Binder binder)

Specified by:

configure in interface Jooby.Module

config

public com.typesafe.config.Config config()

Specified by:

config in interface Jooby.Module