Package io.honeycomb.libhoney.eventdata

Class EventData<T extends EventData<T>>

java.lang.Object

io.honeycomb.libhoney.eventdata.EventData<T>

Type Parameters:

T - That allows subclasses to fix the type parameter, so that builder methods in this class return the subclass type T.

Direct Known Subclasses:

Event, ResolvedEvent

public abstract class EventData<T extends EventData<T>>
extends Object

Abstract class to hold properties common to both Event and ResolvedEvent.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EventData(URI apiHost, String writeKey, String dataset, int sampleRate, Long timestamp, Map<String,Object> fields, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
T	addField(String fieldKey, Object fieldValue)
T	addFields(Map<String,?> fields)
T	addMetadata(String metadataKey, Object metadataValue)
T	addMetadata(Map<String,?> metadata)
URI	getApiHost()
String	getDataset()
Map<String,Object>	getFields()
Map<String,Object>	getMetadata()
int	getSampleRate()
protected abstract T	getSelf()
Long	getTimestamp()
String	getWriteKey()
T	setApiHost(URI apiHost)
T	setDataset(String dataset)
protected T	setSampleRate(int sampleRate)
T	setTimestamp(long timestamp)	Sets an explicit timestamp.
T	setWriteKey(String writeKey)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

EventData

protected EventData(URI apiHost,
                    String writeKey,
                    String dataset,
                    int sampleRate,
                    Long timestamp,
                    Map<String,Object> fields,
                    Map<String,Object> metadata)

Method Detail

getSelf

protected abstract T getSelf()

setSampleRate

protected T setSampleRate(int sampleRate)

setApiHost

public T setApiHost(URI apiHost)

Parameters:

apiHost - to set.

Returns:

this.

See Also:

Options.Builder.setApiHost(URI)

setWriteKey

public T setWriteKey(String writeKey)

Parameters:

writeKey - to set.

Returns:

this.

See Also:

Options.Builder.setWriteKey(String)

setDataset

public T setDataset(String dataset)

Parameters:

dataset - to set.

Returns:

this.

See Also:

Options.Builder.setDataset(String)

setTimestamp

public T setTimestamp(long timestamp)

Sets an explicit timestamp. The instant the timestamp describes must be measured in milliseconds since the epoch. Not setting this means a timestamp set to "now" will be generated on send().

Parameters:

timestamp - to set (millis since the epoch).

Returns:

this.

See Also:

System.currentTimeMillis()

addField

public T addField(String fieldKey,
                  Object fieldValue)

Parameters:

fieldKey - to add.

fieldValue - to add.

Returns:

this.

See Also:

Options.Builder.setGlobalFields(Map)

addFields

public T addFields(Map<String,?> fields)

Parameters:

fields - to add.

Returns:

this.

See Also:

Options.Builder.setGlobalFields(Map)

addMetadata

public T addMetadata(String metadataKey,
                     Object metadataValue)

Parameters:

metadataKey - to add.

metadataValue - to add.

Returns:

this. Add the provided key-value the event metadata.

addMetadata

public T addMetadata(Map<String,?> metadata)

Parameters:

metadata - to add.

Returns:

this. Add the provided map of metadata to this event.

getApiHost

public URI getApiHost()

getWriteKey

public String getWriteKey()

getDataset

public String getDataset()

getSampleRate

public int getSampleRate()

getFields

public Map<String,Object> getFields()

getTimestamp

public Long getTimestamp()

getMetadata

public Map<String,Object> getMetadata()

toString

public String toString()

Overrides:

toString in class Object