org.fulib.yaml

Class EventSource

java.lang.Object

org.fulib.yaml.EventSource

public class EventSource
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
java.text.DateFormat	dateFormat
static java.lang.String	EVENT_KEY
static java.lang.String	EVENT_TIMESTAMP
static java.lang.String	EVENT_TYPE

Constructor Summary

Constructors

Constructor and Description
EventSource()

Method Summary

Modifier and Type	Method and Description
void	addEventListener(java.util.function.Consumer<? super java.util.Map<java.lang.String,java.lang.String>> listener)
EventSource	append(java.util.LinkedHashMap<java.lang.String,java.lang.String> event) Deprecated. since 1.2; use append(Map) instead
EventSource	append(java.util.Map<java.lang.String,java.lang.String> event) Adds the given event to this event source.
EventSource	append(java.lang.String yaml) Deprecated. since 1.2; parse the YAML yourself and use append(Map)
java.lang.String	encodeYaml()
static java.lang.String	encodeYaml(java.util.LinkedHashMap<java.lang.String,java.lang.String> event) Deprecated. since 1.2; use YamlGenerator.serialize(Map) instead
static java.lang.String	encodeYaml(java.util.List<? extends java.util.Map<java.lang.String,java.lang.String>> events) Deprecated. since 1.2; use YamlGenerator.serialize(Iterable) instead
static java.lang.String	encodeYaml(java.util.SortedMap<java.lang.Long,? extends java.util.Map<java.lang.String,java.lang.String>> events) Deprecated. since 1.2; use YamlGenerator.encodeYaml(events.values()) instead
void	encodeYaml(java.io.Writer writer)
java.util.LinkedHashMap<java.lang.String,java.lang.String>	getEvent(java.lang.String eventKey) Deprecated. since 1.2; use getNewestEvent(String) instead
java.util.SortedMap<java.lang.Long,java.util.Map<java.lang.String,java.lang.String>>	getEvents() Gets all events, sorted by timestamp.
java.util.SortedMap<java.lang.Long,java.util.Map<java.lang.String,java.lang.String>>	getEvents(long since) Gets all events after or at the specified timestamp.
java.util.SortedMap<java.lang.Long,java.util.Map<java.lang.String,java.lang.String>>	getEvents(long since, java.util.function.BiPredicate<? super java.lang.Long,? super java.util.Map<java.lang.String,java.lang.String>> filterOp) Gets all events after or at the specified timestamp that fulfill the given predicate.
java.util.SortedMap<java.lang.Long,java.util.Map<java.lang.String,java.lang.String>>	getEvents(long since, java.lang.String... relevantEventTypes) Gets all events after or at the specified timestamp that have any one of the relevant event types.
long	getLastEventTime()
java.util.Map<java.lang.String,java.lang.String>	getNewestEvent(java.lang.String eventKey) Gets the newest event with the given key, or null if not found.
boolean	isOverwritten(java.util.LinkedHashMap<java.lang.String,java.lang.String> event) Deprecated. since 1.2; use isOverwritten(Map) instead
boolean	isOverwritten(java.util.Map<java.lang.String,java.lang.String> event) Checks whether the given event was already overwritten, i.e.
java.util.SortedMap<java.lang.Long,java.util.LinkedHashMap<java.lang.String,java.lang.String>>	pull(long since) Deprecated. since 1.2; use getEvents(long) instead
java.util.SortedMap<java.lang.Long,java.util.LinkedHashMap<java.lang.String,java.lang.String>>	pull(long since, java.util.function.Function<java.util.Map.Entry<java.lang.Long,java.util.LinkedHashMap<java.lang.String,java.lang.String>>,java.lang.Boolean> filterOp) Deprecated. since 1.2; use getEvents(long, BiPredicate) instead
java.util.SortedMap<java.lang.Long,java.util.LinkedHashMap<java.lang.String,java.lang.String>>	pull(long since, java.lang.String... relevantEventTypes) Deprecated. since 1.2; use getEvents(long, String...) instead
EventSource	setOldEventTimeStamp(long oldEventTimeStamp) Sets the timestamp to use for the next event added with append(Map).
EventSource	setOldEventTimeStamp(java.lang.String oldEventTimeStamp) Deprecated. since 1.2; parse the string yourself and use setOldEventTimeStamp(long)

Methods inherited from class java.lang.Object

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

Field Detail

EVENT_KEY

public static final java.lang.String EVENT_KEY

See Also:

Constant Field Values

EVENT_TIMESTAMP

public static final java.lang.String EVENT_TIMESTAMP

See Also:

Constant Field Values

EVENT_TYPE

public static final java.lang.String EVENT_TYPE

See Also:

Constant Field Values

dateFormat

public java.text.DateFormat dateFormat

Constructor Detail

EventSource

public EventSource()

Method Detail

getLastEventTime

public long getLastEventTime()

pull

@Deprecated
public java.util.SortedMap<java.lang.Long,java.util.LinkedHashMap<java.lang.String,java.lang.String>> pull(long since)

Deprecated. since 1.2; use getEvents(long) instead

Gets all events after or at the specified timestamp.

Parameters:

since - the timestamp

Returns:

all events after or at the specified timestamp

pull

@Deprecated
public java.util.SortedMap<java.lang.Long,java.util.LinkedHashMap<java.lang.String,java.lang.String>> pull(long since,
                                                                                                                       java.lang.String... relevantEventTypes)

Deprecated. since 1.2; use getEvents(long, String...) instead

Gets all events after or at the specified timestamp that have any one of the relevant event types.

Parameters:

since - the timestamp

relevantEventTypes - the relevant event types

Returns:

all events after or at the specified timestamp that have any one of the relevant event types

pull

@Deprecated
public java.util.SortedMap<java.lang.Long,java.util.LinkedHashMap<java.lang.String,java.lang.String>> pull(long since,
                                                                                                                       java.util.function.Function<java.util.Map.Entry<java.lang.Long,java.util.LinkedHashMap<java.lang.String,java.lang.String>>,java.lang.Boolean> filterOp)

Deprecated. since 1.2; use getEvents(long, BiPredicate) instead

Gets all events after or at the specified timestamp that fulfill the given predicate.

Parameters:

since - the timestamp

filterOp - the predicate on timestamp and event

Returns:

all events after or at the specified timestamp that fulfill the given predicate

getEvents

public java.util.SortedMap<java.lang.Long,java.util.Map<java.lang.String,java.lang.String>> getEvents()

Gets all events, sorted by timestamp.

Returns:

all events, sorted by timestamp

Since:

1.2

getEvents

public java.util.SortedMap<java.lang.Long,java.util.Map<java.lang.String,java.lang.String>> getEvents(long since)

Gets all events after or at the specified timestamp.

Parameters:

since - the timestamp

Returns:

all events after or at the specified timestamp

Since:

1.2

getEvents

public java.util.SortedMap<java.lang.Long,java.util.Map<java.lang.String,java.lang.String>> getEvents(long since,
                                                                                                      java.lang.String... relevantEventTypes)

Gets all events after or at the specified timestamp that have any one of the relevant event types.

Parameters:

since - the timestamp

relevantEventTypes - the relevant event types

Returns:

all events after or at the specified timestamp that have any one of the relevant event types

Since:

1.2

getEvents

public java.util.SortedMap<java.lang.Long,java.util.Map<java.lang.String,java.lang.String>> getEvents(long since,
                                                                                                      java.util.function.BiPredicate<? super java.lang.Long,? super java.util.Map<java.lang.String,java.lang.String>> filterOp)

Gets all events after or at the specified timestamp that fulfill the given predicate.

Parameters:

since - the timestamp

filterOp - the predicate on timestamp and event

Returns:

all events after or at the specified timestamp that fulfill the given predicate

Since:

1.2

getEvent

@Deprecated
public java.util.LinkedHashMap<java.lang.String,java.lang.String> getEvent(java.lang.String eventKey)

Deprecated. since 1.2; use getNewestEvent(String) instead

Gets the newest event with the given key, or null if not found.

Parameters:

eventKey - the event key

Returns:

the newest event with the given key

getNewestEvent

public java.util.Map<java.lang.String,java.lang.String> getNewestEvent(java.lang.String eventKey)

Gets the newest event with the given key, or null if not found.

Parameters:

eventKey - the event key

Returns:

the newest event with the given key

Since:

1.2

isOverwritten

@Deprecated
public boolean isOverwritten(java.util.LinkedHashMap<java.lang.String,java.lang.String> event)

Deprecated. since 1.2; use isOverwritten(Map) instead

Checks whether the given event was already overwritten, i.e. whether a newer event with the same key exists.

Parameters:

event - the event

Returns:

true if the event was overwritten, false otherwise.

isOverwritten

public boolean isOverwritten(java.util.Map<java.lang.String,java.lang.String> event)

Checks whether the given event was already overwritten, i.e. whether a newer event with the same key exists.

Parameters:

event - the event

Returns:

true if the event was overwritten, false otherwise.

Since:

1.2

addEventListener

public void addEventListener(java.util.function.Consumer<? super java.util.Map<java.lang.String,java.lang.String>> listener)

setOldEventTimeStamp

@Deprecated
public EventSource setOldEventTimeStamp(java.lang.String oldEventTimeStamp)

Deprecated. since 1.2; parse the string yourself and use setOldEventTimeStamp(long)

Sets the timestamp to use for the next event added with append(Map).

Parameters:

oldEventTimeStamp - the old timestamp, as a string

Returns:

this instance, to allow method chaining

setOldEventTimeStamp

public EventSource setOldEventTimeStamp(long oldEventTimeStamp)

Sets the timestamp to use for the next event added with append(Map).

Parameters:

oldEventTimeStamp - the old timestamp, as a string

Returns:

this instance, to allow method chaining

Since:

1.2

append

@Deprecated
public EventSource append(java.util.LinkedHashMap<java.lang.String,java.lang.String> event)

Deprecated. since 1.2; use append(Map) instead

Adds the given event to this event source.

Parameters:

event - the event

Returns:

this instance, to allow method chaining

append

public EventSource append(java.util.Map<java.lang.String,java.lang.String> event)

Adds the given event to this event source.

Parameters:

event - the event

Returns:

this instance, to allow method chaining

Since:

1.2

append

@Deprecated
public EventSource append(java.lang.String yaml)

Deprecated. since 1.2; parse the YAML yourself and use append(Map)

Parses the string as a YAML object list and adds each object as an event via append(Map).

Parameters:

yaml - the YAML object list

Returns:

this instance, to allow method chaining

encodeYaml

public java.lang.String encodeYaml()

encodeYaml

public void encodeYaml(java.io.Writer writer)
                throws java.io.IOException

Throws:

java.io.IOException

encodeYaml

@Deprecated
public static java.lang.String encodeYaml(java.util.SortedMap<java.lang.Long,? extends java.util.Map<java.lang.String,java.lang.String>> events)

Deprecated. since 1.2; use YamlGenerator.encodeYaml(events.values()) instead

Encodes the events as a list of YAML objects.

Parameters:

events - the events

Returns:

the encoded YAML object list

encodeYaml

@Deprecated
public static java.lang.String encodeYaml(java.util.List<? extends java.util.Map<java.lang.String,java.lang.String>> events)

Deprecated. since 1.2; use YamlGenerator.serialize(Iterable) instead

Encodes the events as a list of YAML objects.

Parameters:

events - the events

Returns:

the encoded YAML object list

encodeYaml

@Deprecated
public static java.lang.String encodeYaml(java.util.LinkedHashMap<java.lang.String,java.lang.String> event)

Deprecated. since 1.2; use YamlGenerator.serialize(Map) instead

Encodes the event as a YAML object.

Parameters:

event - the event

Returns:

the encoded YAML object