io.inversion.action.misc

Class CsvAction

java.lang.Object

io.inversion.Rule<A>

io.inversion.Action<CsvAction>

io.inversion.action.misc.CsvAction

All Implemented Interfaces:

OpenAPIWriter<CsvAction>, java.lang.Comparable<CsvAction>

public class CsvAction
extends Action<CsvAction>

Converts a JSON object/array response value into CSV format.

Works for a status code 200 GET request when 'format=csv' is passed in on the query string or the Endpoint or an action has 'format=csv' as part of its config.

Nested Class Summary

Nested classes/interfaces inherited from class io.inversion.Rule

Rule.RuleMatcher

Field Summary

Fields inherited from class io.inversion.Rule

ALL_METHODS, configMap, description, excludeMatchers, excludeOn, includeMatchers, includeOn, log, name, order, params

Constructor Summary

Constructors

Constructor and Description
CsvAction()

Method Summary

Modifier and Type	Method and Description
void	run(Request req, Response res) Override this method with your custom business logic or override one of the http method "doMETHOD" specific handlers.
java.lang.String	toCsv(io.inversion.json.JSList arr)

Methods inherited from class io.inversion.Action

configureOp, doDelete, doGet, doPatch, doPost, doPut, getFullIncludePaths, getIncludePaths, isDecoration, joinPaths, joinPaths0, run0, withDecoration

Methods inherited from class io.inversion.Rule

afterWiringComplete, checkLazyConfig, compareTo, doLazyConfig, getAllExcludePaths, getAllIncludeMethods, getAllIncludePaths, getDefaultIncludeMatchers, getDescription, getExcludeMatchers, getIncludeMatchers, getName, getOrder, getParams, match, match, matches, matches, toString, withDescription, withExcludeOn, withExcludeOn, withIncludeOn, withIncludeOn, withName, withOrder, withParam, withParams

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.inversion.action.openapi.OpenAPIWriter

addResponse, addResponse, beautifyTag, buildOperation, documentOpDelete, documentOperationSchema, documentOpFind, documentOpGet, documentOpPatch, documentOpPost, documentOpPut, documentOpRelated, documentParam, documentQueryParams, documentRequestSchema, documentResourceSchema, documentResponseSchema, findOp, getDescription, getSchemaRef, hasParam, hook_documentOp, newComponentRefSchema, newHrefSchema, newTypeSchema, removeReadOnlyProperties

Constructor Detail

CsvAction

public CsvAction()

Method Detail

run

public void run(Request req,
                Response res)
         throws ApiException

Description copied from class: Action

Override this method with your custom business logic or override one of the http method "doMETHOD" specific handlers.

Overrides:

run in class Action<CsvAction>

Parameters:

req - the Request being serviced

res - the Reponse being generated

Throws:

ApiException

toCsv

public java.lang.String toCsv(io.inversion.json.JSList arr)
                       throws ApiException

Throws:

ApiException