water.api

Class DocsBase<I extends DocsHandler.DocsPojo,S extends DocsBase<I,S>>

java.lang.Object

water.Iced

water.api.Schema<I,DocsBase<I,S>>

water.api.DocsBase<I,S>

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Freezable

Direct Known Subclasses:

DocsV1

public class DocsBase<I extends DocsHandler.DocsPojo,S extends DocsBase<I,S>>
extends Schema<I,DocsBase<I,S>>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	classname
java.lang.String	http_method
int	num
java.lang.String	path
RouteBase[]	routes
SchemaMetadataBase[]	schemas

Fields inherited from class water.api.Schema

_version_pattern, schema_name, schema_type, schema_version

Constructor Summary

Constructors

Constructor and Description
DocsBase()

Method Summary

Methods

Modifier and Type	Method and Description
DocsBase	fillFromImpl(DocsHandler.DocsPojo impl) Version and Schema-specific filling from the implementation object.

Methods inherited from class water.api.Schema

acceptsFrame, createAndFillImpl, createImpl, extractVersion, fillFromParms, fillImpl, getImplClass, getImplClass, markdown, markdown, register

Methods inherited from class water.Iced

clone, frozenType, read_impl, read, readExternal, readJSON_impl, readJSON, write_impl, write, writeExternal, writeHTML_impl, writeHTML, writeJSON_impl, writeJSON

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

num

@API(help="Number for specifying an endpoint",
     json=false)
public int num

http_method

@API(help="HTTP method (GET, POST, DELETE) if fetching by path",
     json=false)
public java.lang.String http_method

path

@API(help="Path for specifying an endpoint",
     json=false)
public java.lang.String path

classname

@API(help="Class name, for fetching docs for a schema",
     json=false)
public java.lang.String classname

routes

@API(help="List of endpoint routes.")
public RouteBase[] routes

schemas

@API(help="List of schemas.")
public SchemaMetadataBase[] schemas

Constructor Detail

DocsBase

public DocsBase()

Method Detail

fillFromImpl

public DocsBase fillFromImpl(DocsHandler.DocsPojo impl)

Description copied from class: Schema

Version and Schema-specific filling from the implementation object.

Overrides:

fillFromImpl in class Schema<I extends DocsHandler.DocsPojo,DocsBase<I extends DocsHandler.DocsPojo,S extends DocsBase<I,S>>>