io.baratine.web.ViewRender Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
A reactive Java web server.
The newest version!
/*
 * Copyright (c) 1998-2015 Caucho Technology -- all rights reserved
 *
 * This file is part of Baratine(TM)
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Baratine is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Baratine is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Baratine; if not, write to the
 *
 *   Free Software Foundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 *
 * @author Scott Ferguson
 */

package io.baratine.web;

/**
 * Interface ViewRender provides contract for custom renderers for values of
 * specific type.
 * 
 * E.g.
 * 

 * Creating a custom renderer
 * 
 * public class MyBeanRender implements ViewRender<MyBean>
 * {
 *   @Override
 *   public void render(RequestWeb requestWeb, MyBean myBean)
 *   {
 *     requestWeb.write("<to-string>");
 *     requestWeb.write(myBean.toString());
 *     requestWeb.write("</to-string>");
 *     requestWeb.ok();
 *   }
 * }
 * 
 * 
 * register renderer in one of the following ways:
 * 
 *   //using instance
 *   Web.view(new MyBeanRender());
 *   // or using class
 *   Web.view(MyBeanRender.class);
 * 
 * 
 * use with service
 * 

 * View renderer is choosen based on the type of the result passed into
 * ok(Object) method of the RequestWeb.
 * 

 * 
 *   @Service
 *   public class MyService {
 *     @Get
 *     public void myBean(RequestWeb request) {
 *       request.ok(new MyBean());
 *     }
 *   }
 * 
 *
 * @param  type of value to render
 */
public interface ViewRender
{
  /**
   * Directly renders the value
   *
   * @param req   the web request
   * @param value the value to be rendered
   */
  void render(RequestWeb req, T value);
}