Package play.core

Interface BuildDocHandler

public interface BuildDocHandler
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.

BuildDocHandler objects can created by calling the static methods on BuildDocHandlerFactory.

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.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    maybeHandleDocRequest(Object request)
    Given a request, either handle it and return some result, or don't, and return none.

  • Method Details

    • maybeHandleDocRequest

      Object maybeHandleDocRequest(Object request)
      Given a request, either handle it and return some result, or don't, and return none.
      Parameters:
      request - A request of type play.api.mvc.RequestHeader.
      Returns:
      A value of type Option<play.api.mvc.SimpleResult>, Some if the result was handled, None otherwise.