Interface MarketPriceWriter

All Known Implementing Classes:

CsvMarketPriceWriter

public interface MarketPriceWriter

Defines the writer for market prices.

Version:

1.0.6

Author:

Stephen Prizio

Method Summary

Modifier and Type	Method	Description
default void	validateWriterParameters(SymbolAlias symbolAlias, MarketTimeInterval timeInterval, String delimiter)	Validates the given parameters before writing.
String	writeMarketPrices(SymbolAlias symbolAlias, MarketTimeInterval timeInterval, String delimiter)	Writes market prices for the given SymbolAlias and interval using unix timestamps.
String	writeMarketPrices(SymbolAlias symbolAlias, MarketTimeInterval timeInterval, String delimiter, String dateTimeFormat)	Writes market prices for the given SymbolAlias and interval using the provided date time format when present.
String	writeMarketPrices(SymbolAlias symbolAlias, MarketTimeInterval timeInterval, LocalDateTime start, LocalDateTime end, String delimiter, String dateTimeFormat)	Writes market prices for the given SymbolAlias and interval, filtered by the optional start and end period bounds.
void	writeMarketPrices(SymbolAlias symbolAlias, MarketTimeInterval timeInterval, LocalDateTime start, LocalDateTime end, String delimiter, String dateTimeFormat, Writer writer)	Writes market prices for the given SymbolAlias and interval to the provided writer, filtered by the optional start and end period bounds.

Method Details

writeMarketPrices

String writeMarketPrices(SymbolAlias symbolAlias,
 MarketTimeInterval timeInterval,
 String delimiter)

Writes market prices for the given SymbolAlias and interval using unix timestamps.

Parameters:

symbolAlias - SymbolAlias

timeInterval - MarketTimeInterval

delimiter - delimiter

Returns:

string

writeMarketPrices

String writeMarketPrices(SymbolAlias symbolAlias,
 MarketTimeInterval timeInterval,
 String delimiter,
 String dateTimeFormat)

Writes market prices for the given SymbolAlias and interval using the provided date time format when present.

Parameters:

symbolAlias - SymbolAlias

timeInterval - MarketTimeInterval

delimiter - delimiter

dateTimeFormat - optional date time format

Returns:

string

writeMarketPrices

String writeMarketPrices(SymbolAlias symbolAlias,
 MarketTimeInterval timeInterval,
 LocalDateTime start,
 LocalDateTime end,
 String delimiter,
 String dateTimeFormat)

Writes market prices for the given SymbolAlias and interval, filtered by the optional start and end period bounds.

Parameters:

symbolAlias - SymbolAlias

timeInterval - MarketTimeInterval

start - optional start date time, inclusive

end - optional end date time, exclusive

delimiter - delimiter

dateTimeFormat - optional date time format

Returns:

string

writeMarketPrices

void writeMarketPrices(SymbolAlias symbolAlias,
 MarketTimeInterval timeInterval,
 LocalDateTime start,
 LocalDateTime end,
 String delimiter,
 String dateTimeFormat,
 Writer writer)
                throws IOException

Writes market prices for the given SymbolAlias and interval to the provided writer, filtered by the optional start and end period bounds.

Parameters:

symbolAlias - SymbolAlias

timeInterval - MarketTimeInterval

start - optional start date time, inclusive

end - optional end date time, exclusive

delimiter - delimiter

dateTimeFormat - optional date time format

writer - destination writer

Throws:

IOException - io exception while writing

validateWriterParameters

default void validateWriterParameters(SymbolAlias symbolAlias,
 MarketTimeInterval timeInterval,
 String delimiter)

Validates the given parameters before writing.

Parameters:

symbolAlias - SymbolAlias

timeInterval - MarketTimeInterval

delimiter - delimiter