- java.lang.Object
-
- aeonics.template.Template<Endpoint.Type>
-
- aeonics.http.Endpoint.Template
-
- All Implemented Interfaces:
Documented
,Exportable
- Enclosing class:
- Endpoint
public static class Endpoint.Template extends Template<Endpoint.Type>
Superclass template for endpoints
-
-
Constructor Summary
Constructors Constructor Description Template(java.lang.Class<? extends Endpoint.Type> target, java.lang.Class<? extends Endpoint> type)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Data
export()
Renders this class instance to a simple data structure for rendering client-side.java.lang.String
returns()
Returns the documentation of the endpoint return valueEndpoint.Template
returns(java.lang.String value)
Sets the documentation of the endpoint return value-
Methods inherited from class aeonics.template.Template
add, add, cast, category, category, category, config, config, config, config, config, create, create, creator, description, description, enforceParameterValidation, enforceParameterValidation, name, onCreate, onUpdate, removeParameter, removeRelationship, summary, summary, target, target, type, type, update
-
-
-
-
Constructor Detail
-
Template
public Template(java.lang.Class<? extends Endpoint.Type> target, java.lang.Class<? extends Endpoint> type)
-
-
Method Detail
-
returns
public java.lang.String returns()
Returns the documentation of the endpoint return value- Returns:
- the documentation of the endpoint return value
-
returns
public Endpoint.Template returns(java.lang.String value)
Sets the documentation of the endpoint return value- Parameters:
value
- the documentation of the endpoint return value- Returns:
- this
-
export
public Data export()
Description copied from interface:Exportable
Renders this class instance to a simple data structure for rendering client-side.- Specified by:
export
in interfaceDocumented
- Specified by:
export
in interfaceExportable
- Overrides:
export
in classTemplate<Endpoint.Type>
- Returns:
- a public data representation of this class instance
-
-