groovyx.net.http.optional

Class Csv

java.lang.Object

groovyx.net.http.optional.Csv

public class Csv
extends java.lang.Object

Optional CSV encoder/parser implementation based on the [OpenCSV](http://opencsv.sourceforge.net/) library. It will be available when the OpenCsv library is on the classpath (an optional dependency).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Csv.Context

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.function.Supplier<java.util.function.BiConsumer<ChainedHttpConfig,ToServer>>	encoderSupplier
static java.util.function.Supplier<java.util.function.BiFunction<ChainedHttpConfig,FromServer,java.lang.Object>>	parserSupplier

Constructor Summary

Constructors

Constructor and Description
Csv()

Method Summary

Modifier and Type	Method and Description
static void	encode(ChainedHttpConfig config, ToServer ts) Used to encode the request content using the OpenCsv writer.
static java.lang.Object	parse(ChainedHttpConfig config, FromServer fromServer) Used to parse the server response content using the OpenCsv parser.
static void	toCsv(HttpConfig delegate, char separator) Used to configure the OpenCsv encoder/parser in the configuration context for the text/csv content-type.
static void	toCsv(HttpConfig delegate, char separator, char quote) Used to configure the OpenCsv encoder/parser in the configuration context for the text/csv content-type.
static void	toCsv(HttpConfig delegate, java.lang.String contentType, java.lang.Character separator, java.lang.Character quote) Used to configure the OpenCsv encoder/parser in the configuration context for the specified content type.
static void	toTsv(HttpConfig delegate, char quote) Used to configure the OpenCsv encoder/parser in the configuration context for the text/tab-separated-values content type, with a tab as the column separator character.

Methods inherited from class java.lang.Object

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

Field Detail

encoderSupplier

public static final java.util.function.Supplier<java.util.function.BiConsumer<ChainedHttpConfig,ToServer>> encoderSupplier

parserSupplier

public static final java.util.function.Supplier<java.util.function.BiFunction<ChainedHttpConfig,FromServer,java.lang.Object>> parserSupplier

Constructor Detail

Csv

public Csv()

Method Detail

parse

public static java.lang.Object parse(ChainedHttpConfig config,
                                     FromServer fromServer)

Used to parse the server response content using the OpenCsv parser.

Parameters:

config - the configuration

fromServer - the server content accessor

Returns:

the parsed object

encode

public static void encode(ChainedHttpConfig config,
                          ToServer ts)

Used to encode the request content using the OpenCsv writer.

Parameters:

config - the configuration

ts - the server request content accessor

toCsv

public static void toCsv(HttpConfig delegate,
                         java.lang.String contentType,
                         java.lang.Character separator,
                         java.lang.Character quote)

Used to configure the OpenCsv encoder/parser in the configuration context for the specified content type.

Parameters:

delegate - the configuration object

contentType - the content type to be registered

separator - the CSV column separator character

quote - the CSV quote character

toCsv

public static void toCsv(HttpConfig delegate,
                         char separator)

Used to configure the OpenCsv encoder/parser in the configuration context for the text/csv content-type. No quote character will be provided.

Parameters:

delegate - the configuration object

separator - the CSV column separator character

toCsv

public static void toCsv(HttpConfig delegate,
                         char separator,
                         char quote)

Used to configure the OpenCsv encoder/parser in the configuration context for the text/csv content-type.

Parameters:

delegate - the configuration object

separator - the CSV column separator character

quote - the CSV quote character

toTsv

public static void toTsv(HttpConfig delegate,
                         char quote)

Used to configure the OpenCsv encoder/parser in the configuration context for the text/tab-separated-values content type, with a tab as the column separator character.

Parameters:

delegate - the configuration object

quote - the quote character to be used