com.devexperts.mdd.news.event

Class NewsFilter

java.lang.Object

com.devexperts.mdd.news.event.NewsFilter

All Implemented Interfaces:

Serializable

public class NewsFilter
extends Object
implements Serializable

Filter for news events.

Sample builder usage:

     NewsFilter filter = NewsFilter.newBuilder()
         .withSources("Business Wire")
         .withSymbols("AAPL", "MSFT")
         .withLimit(50)
         .withTimeout(60_000L)
         .build();
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NewsFilter.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_LIMIT Default (and maximum) limit for the news count returned in one chunk.
static long	DEFAULT_TIMEOUT Default (and maximum) time period to wait while polling for news.
static NewsFilter	EMPTY_FILTER Empty filter with all params set by default.
static String	FILTER_FEED
static String	FILTER_LIMIT
static Set<String>	FILTER_PARAMETERS Set of all available fields for the filter.
static String	FILTER_SOURCE
static String	FILTER_SYMBOL
static String	FILTER_TIMEOUT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NewsFilter(Map<String,Set<String>> params)

Method Summary

Modifier and Type	Method and Description
NewsFilter.Builder	builder()
static NewsFilter	emptyFilter()
Set<String>	getFeeds() Returns set of feeds to filter on, or null otherwise.
int	getLimit() Returns maximum number of news to return.
Set<String>	getParam(String name)
Map<String,Set<String>>	getParams() Returns all filter parameters as a map.
Set<String>	getSources() Returns set of news sources to filter on, or null otherwise.
Set<String>	getSymbols() Returns set of instrument symbols to filter on, or null otherwise.
long	getTimeout() Sets the timeout in millis to wait while polling for news.
static NewsFilter	limitFilter(int limit)
static NewsFilter.Builder	newBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

FILTER_FEED

public static final String FILTER_FEED

See Also:

getFeeds(), Constant Field Values

FILTER_SOURCE

public static final String FILTER_SOURCE

See Also:

getSources(), Constant Field Values

FILTER_SYMBOL

public static final String FILTER_SYMBOL

See Also:

getSymbols(), Constant Field Values

FILTER_LIMIT

public static final String FILTER_LIMIT

See Also:

getLimit(), Constant Field Values

FILTER_TIMEOUT

public static final String FILTER_TIMEOUT

See Also:

getTimeout(), Constant Field Values

FILTER_PARAMETERS

public static final Set<String> FILTER_PARAMETERS

Set of all available fields for the filter.

EMPTY_FILTER

public static final NewsFilter EMPTY_FILTER

Empty filter with all params set by default.

DEFAULT_LIMIT

public static final int DEFAULT_LIMIT

Default (and maximum) limit for the news count returned in one chunk.

See Also:

Constant Field Values

DEFAULT_TIMEOUT

public static final long DEFAULT_TIMEOUT

Default (and maximum) time period to wait while polling for news.

See Also:

Constant Field Values

Constructor Detail

NewsFilter

protected NewsFilter(Map<String,Set<String>> params)

Method Detail

newBuilder

public static NewsFilter.Builder newBuilder()

limitFilter

public static NewsFilter limitFilter(int limit)

emptyFilter

public static NewsFilter emptyFilter()

builder

public NewsFilter.Builder builder()

getFeeds

public Set<String> getFeeds()

Returns set of feeds to filter on, or null otherwise.

getSources

public Set<String> getSources()

Returns set of news sources to filter on, or null otherwise.

getSymbols

public Set<String> getSymbols()

Returns set of instrument symbols to filter on, or null otherwise.

getLimit

public int getLimit()

Returns maximum number of news to return.

getTimeout

public long getTimeout()

Sets the timeout in millis to wait while polling for news.

getParams

public Map<String,Set<String>> getParams()

Returns all filter parameters as a map.

getParam

public Set<String> getParam(String name)

toString

public String toString()

Overrides:

toString in class Object