Play Framework/Scala example source code file (BuildDocHandler.java)

This example Play Framework source code file (BuildDocHandler.java) is included in my "Source Code Warehouse" project. The intent of this project is to help you more easily find Play Framework (and Scala) source code examples by using tags.

All credit for the original source code belongs to Play Framework; I'm just trying to make examples easier to find. (For my Scala work, see my Scala examples and tutorials.)

Play Framework tags/keywords

builddochandler, core, object, play, play framework

The BuildDocHandler.java Play Framework example source code

/*
 * Copyright (C) 2009-2013 Typesafe Inc. <http://www.typesafe.com>
 */
package play.core;

/**
 * Interface used by the build to call a DocumentationHandler. We don't use
 * a DocumentationHandler directly because Play's build and application code can be compiled
 * with different versions of Scala and there can be binary compatibility problems.
 *
 * <p>BuildDocHandler objects can created by calling the static methods on BuildDocHandlerFactory.
 *
 * <p>This interface is written in Java and uses only Java types so that
 * communication can work even when the calling code and the play-docs project
 * are built with different versions of Scala.
 */
public interface BuildDocHandler {

  /**
   * Given a request, either handle it and return some result, or don't, and return none.
   *
   * @param request A request of type {@link play.api.mvc.RequestHeader}.
   * @return A value of type {@link Option<play.api.mvc.SimpleResult>}, Some if the result was
   *        handled, None otherwise.
   */
  public Object maybeHandleDocRequest(Object request);

}