/*
 * Copyright 2014 Red Hat, Inc.
 *
 * Red Hat licenses this file to you under the Apache License, version 2.0
 * (the "License"); you may not use this file except in compliance with the
 * License.  You may obtain a copy of the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */

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

import java.util.Map;
import io.reactivex.Observable;
import io.reactivex.Flowable;
import io.reactivex.Single;
import io.reactivex.Completable;
import io.reactivex.Maybe;
import io.vertx.core.AsyncResult;
import io.vertx.core.Handler;

A template engine uses a specific template and the data in a routing context to render a resource into a buffer.

Concrete implementations exist for several well-known template engines.
 NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen. /**
 * A template engine uses a specific template and the data in a routing context to render a resource into a buffer.
 * <p>
 * Concrete implementations exist for several well-known template engines.
 *
 * <p/>
 * NOTE: This class has been automatically generated from the {@link io.vertx.ext.web.templ.TemplateEngine original} non RX-ified interface using Vert.x codegen.
 */

@io.vertx.lang.rx.RxGen(io.vertx.ext.web.templ.TemplateEngine.class)
public class TemplateEngine extends io.vertx.reactivex.ext.web.common.template.TemplateEngine {

  @Override
  public String toString() {
    return delegate.toString();
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) return true;
    if (o == null || getClass() != o.getClass()) return false;
    TemplateEngine that = (TemplateEngine) o;
    return delegate.equals(that.delegate);
  }
  
  @Override
  public int hashCode() {
    return delegate.hashCode();
  }

  public static final io.vertx.lang.rx.TypeArg<TemplateEngine> __TYPE_ARG = new io.vertx.lang.rx.TypeArg<>(    obj -> new TemplateEngine((io.vertx.ext.web.templ.TemplateEngine) obj),
    TemplateEngine::getDelegate
  );

  private final io.vertx.ext.web.templ.TemplateEngine delegate;
  
  public TemplateEngine(io.vertx.ext.web.templ.TemplateEngine delegate) {
    super(delegate);
    this.delegate = delegate;
  }

  public io.vertx.ext.web.templ.TemplateEngine getDelegate() {
    return delegate;
  }

  
Render the template
Params:
context – the routing context
templateFileName – the template file name to use
handler – the handler that will be called with a result containing the buffer or a failure./**
   * Render the template
   * @param context the routing context
   * @param templateFileName the template file name to use
   * @param handler the handler that will be called with a result containing the buffer or a failure.
   */
  @Deprecated()
  public void render(io.vertx.reactivex.ext.web.RoutingContext context, String templateFileName, Handler<AsyncResult<io.vertx.reactivex.core.buffer.Buffer>> handler) { 
    delegate.render(context.getDelegate(), templateFileName, new Handler<AsyncResult<io.vertx.core.buffer.Buffer>>() {
      public void handle(AsyncResult<io.vertx.core.buffer.Buffer> ar) {
        if (ar.succeeded()) {
          handler.handle(io.vertx.core.Future.succeededFuture(io.vertx.reactivex.core.buffer.Buffer.newInstance(ar.result())));
        } else {
          handler.handle(io.vertx.core.Future.failedFuture(ar.cause()));
        }
      }
    });
  }

  
Render the template
Params:
context – the routing context
templateFileName – the template file name to use
Returns:
/**
   * Render the template
   * @param context the routing context
   * @param templateFileName the template file name to use
   * @return 
   */
  @Deprecated()
  public Single<io.vertx.reactivex.core.buffer.Buffer> rxRender(io.vertx.reactivex.ext.web.RoutingContext context, String templateFileName) { 
    return io.vertx.reactivex.impl.AsyncResultSingle.toSingle(handler -> {
      render(context, templateFileName, handler);
    });
  }

  
Render the template

NOTE if you call method directly (i.e. not using TemplateHandler) make sure that templateFileName is sanitized via 
Params:
context – the routing context
templateDirectory – the template directory to use
templateFileName – the relative template file name to use
handler – the handler that will be called with a result containing the buffer or a failure./**
   * Render the template
   * <p>
   * <b>NOTE</b> if you call method directly (i.e. not using {@link io.vertx.reactivex.ext.web.handler.TemplateHandler}) make sure
   * that <i>templateFileName</i> is sanitized via 
   * @param context the routing context
   * @param templateDirectory the template directory to use
   * @param templateFileName the relative template file name to use
   * @param handler the handler that will be called with a result containing the buffer or a failure.
   */
  @Deprecated()
  public void render(io.vertx.reactivex.ext.web.RoutingContext context, String templateDirectory, String templateFileName, Handler<AsyncResult<io.vertx.reactivex.core.buffer.Buffer>> handler) { 
    delegate.render(context.getDelegate(), templateDirectory, templateFileName, new Handler<AsyncResult<io.vertx.core.buffer.Buffer>>() {
      public void handle(AsyncResult<io.vertx.core.buffer.Buffer> ar) {
        if (ar.succeeded()) {
          handler.handle(io.vertx.core.Future.succeededFuture(io.vertx.reactivex.core.buffer.Buffer.newInstance(ar.result())));
        } else {
          handler.handle(io.vertx.core.Future.failedFuture(ar.cause()));
        }
      }
    });
  }

  
Render the template

NOTE if you call method directly (i.e. not using TemplateHandler) make sure that templateFileName is sanitized via 
Params:
context – the routing context
templateDirectory – the template directory to use
templateFileName – the relative template file name to use
Returns:
/**
   * Render the template
   * <p>
   * <b>NOTE</b> if you call method directly (i.e. not using {@link io.vertx.reactivex.ext.web.handler.TemplateHandler}) make sure
   * that <i>templateFileName</i> is sanitized via 
   * @param context the routing context
   * @param templateDirectory the template directory to use
   * @param templateFileName the relative template file name to use
   * @return 
   */
  @Deprecated()
  public Single<io.vertx.reactivex.core.buffer.Buffer> rxRender(io.vertx.reactivex.ext.web.RoutingContext context, String templateDirectory, String templateFileName) { 
    return io.vertx.reactivex.impl.AsyncResultSingle.toSingle(handler -> {
      render(context, templateDirectory, templateFileName, handler);
    });
  }

  
Returns true if the template engine caches template files. If false, then template files are freshly loaded each
time they are used.
Returns:
True if template files are cached; otherwise, false./**
   * Returns true if the template engine caches template files. If false, then template files are freshly loaded each
   * time they are used.
   * @return True if template files are cached; otherwise, false.
   */
  public boolean isCachingEnabled() { 
    boolean ret = delegate.isCachingEnabled();
    return ret;
  }


  public static  TemplateEngine newInstance(io.vertx.ext.web.templ.TemplateEngine arg) {
    return arg != null ? new TemplateEngine(arg) : null;
  }
}