/*
 * Copyright 2014 Red Hat, Inc.
 *
 *  All rights reserved. This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License v1.0
 *  and Apache License v2.0 which accompanies this distribution.
 *
 *  The Eclipse Public License is available at
 *  http://www.eclipse.org/legal/epl-v10.html
 *
 *  The Apache License v2.0 is available at
 *  http://www.opensource.org/licenses/apache2.0.php
 *
 *  You may elect to redistribute this code under either of these licenses.
 */

package io.vertx.ext.web.templ.pebble;

import com.mitchellbosecke.pebble.PebbleEngine;
import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.GenIgnore;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.Vertx;
import io.vertx.ext.web.common.template.TemplateEngine;
import io.vertx.ext.web.templ.pebble.impl.PebbleTemplateEngineImpl;

A template engine that uses the Pebble library.
Author:
Dan Kristensen/**
 * A template engine that uses the Pebble library.
 *
 * @author Dan Kristensen
 */
@VertxGen
public interface PebbleTemplateEngine extends TemplateEngine {

  
Default max number of templates to cache
/**
   * Default max number of templates to cache
   */
  int DEFAULT_MAX_CACHE_SIZE = 10000;

  
Default template extension
/**
   * Default template extension
   */
  @Deprecated
  String DEFAULT_TEMPLATE_EXTENSION = "peb";

  
Create a template engine using defaults
Returns:
the engine/**
   * Create a template engine using defaults
   *
   * @return the engine
   */
  static PebbleTemplateEngine create(Vertx vertx) {
    return new PebbleTemplateEngineImpl(vertx);
  }

  
Create a template engine using a custom Builder, e.g. if
you want use custom Filters or Functions.
Returns:
the engine/**
   * Create a template engine using a custom Builder, e.g. if
   * you want use custom Filters or Functions.
   *
   * @return the engine
   */
  @GenIgnore
  static PebbleTemplateEngine create(PebbleEngine engine) {
    return new PebbleTemplateEngineImpl(engine);
  }

  
Params:
extension – 
           the extension
Deprecated:
as a user you should use filename with extensions on the render method instead of relying
on this method to suffix your filenames. Using this method is quite an opinionated API and has the side
effect that you cannot use files without extensions as templates.
Set the extension for the engine
Returns:
a reference to this for fluency/**
   * @deprecated as a user you should use filename with extensions on the render method instead of relying
   * on this method to suffix your filenames. Using this method is quite an opinionated API and has the side
   * effect that you cannot use files without extensions as templates.
   *
   * Set the extension for the engine
   *
   * @param extension
   *            the extension
   * @return a reference to this for fluency
   */
  @Fluent
  @Deprecated
  PebbleTemplateEngine setExtension(String extension);

  
Set the max cache size for the engine
Params:
maxCacheSize – 
           the maxCacheSize
Returns:
a reference to this for fluency/**
   * Set the max cache size for the engine
   *
   * @param maxCacheSize
   *            the maxCacheSize
   * @return a reference to this for fluency
   */
  @Fluent
  PebbleTemplateEngine setMaxCacheSize(int maxCacheSize);
}