Packages

c

play.docs

DocumentationHandler

class DocumentationHandler extends BuildDocHandler with Closeable

Used by the DocumentationApplication class to handle requests for Play documentation. Documentation is located in the given repository - either a JAR file or directly from the filesystem.

Linear Supertypes
Closeable, AutoCloseable, BuildDocHandler, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DocumentationHandler
  2. Closeable
  3. AutoCloseable
  4. BuildDocHandler
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DocumentationHandler(repo: FileRepository)
  2. new DocumentationHandler(repo: FileRepository, apiRepo: FileRepository)
  3. new DocumentationHandler(repo: FileRepository, toClose: Closeable)
  4. new DocumentationHandler(repo: FileRepository, apiRepo: FileRepository, toClose: Closeable)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. def close(): Unit
    Definition Classes
    DocumentationHandler → Closeable → AutoCloseable
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. val locator: (String) ⇒ String
  14. def maybeHandleDocRequest(request: RequestHeader): Option[Result]

    Handle the given request if it is a request for documentation content.

  15. def maybeHandleDocRequest(request: AnyRef): AnyRef
    Definition Classes
    DocumentationHandler → BuildDocHandler
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. def playDoc: PlayDoc

    This is a def because we want to reindex the docs each time.

  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Closeable

Inherited from AutoCloseable

Inherited from BuildDocHandler

Inherited from AnyRef

Inherited from Any

Ungrouped