me.piggypiglet.framework.http.routes.types.json

Class JsonRoute

java.lang.Object

me.piggypiglet.framework.http.routes.Route

me.piggypiglet.framework.http.routes.types.json.JsonRoute

Direct Known Subclasses:

JsonManagerRoute

public abstract class JsonRoute
extends Route

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.gson.Gson	gson

Fields inherited from class me.piggypiglet.framework.http.routes.Route

HEADERS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JsonRoute(java.lang.String route, com.google.gson.Gson gson, Header... headers)
protected	JsonRoute(java.lang.String route, Header... headers) Provide the path of this route, do not include a forward slash at the beginning.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	run(java.util.Map<java.lang.String,java.util.List<java.lang.String>> params, java.util.List<Header> headers, java.lang.String ip) Process parameters and return a string based on them & the route

Methods inherited from class me.piggypiglet.framework.http.routes.Route

getHeaders, getRoute, provide

Methods inherited from class java.lang.Object

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

Field Detail

gson

protected final com.google.gson.Gson gson

Constructor Detail

JsonRoute

protected JsonRoute(java.lang.String route,
                    Header... headers)

Provide the path of this route, do not include a forward slash at the beginning.

Parameters:

route - Route

headers - Optional headers to append to the page

JsonRoute

protected JsonRoute(java.lang.String route,
                    com.google.gson.Gson gson,
                    Header... headers)

Method Detail

run

public java.lang.Object run(java.util.Map<java.lang.String,java.util.List<java.lang.String>> params,
                            java.util.List<Header> headers,
                            java.lang.String ip)

Description copied from class: Route

Process parameters and return a string based on them & the route

Overrides:

run in class Route

Parameters:

params - Map of params and their value(s). Identical to a multimap, example format would be: url/route?test=oof&test=oof2&oof=test which would result in: {test:["oof", "oof2"],oof:["test"]}

headers - List of headers

ip - Client ip

Returns:

Object, will be converted to string