com.snowplowanalytics.snowplow.event

Class AbstractEvent

java.lang.Object

com.snowplowanalytics.snowplow.event.AbstractEvent

All Implemented Interfaces:

Event

Direct Known Subclasses:

AbstractPrimitive, AbstractSelfDescribing

public abstract class AbstractEvent
extends Object
implements Event

Base AbstractEvent class which contains common elements to all events: - Custom Context: list of custom contexts or null - Timestamp: user defined event timestamp or 0 - AbstractEvent Id: a unique id for the event

Field Summary

Fields

Modifier and Type	Field and Description
List<SelfDescribingJson>	customContexts List of custom contexts associated to the event.
Long	trueTimestamp Custom timestamp of the event.

Constructor Summary

Constructors

Constructor and Description
AbstractEvent()

Method Summary

Modifier and Type	Method and Description
void	beginProcessing(com.snowplowanalytics.snowplow.internal.tracker.Tracker tracker) Hook method called just before the event processing in order to execute special operations.
AbstractEvent	contexts(List<SelfDescribingJson> contexts) Adds a list of contexts.
void	endProcessing(com.snowplowanalytics.snowplow.internal.tracker.Tracker tracker) Hook method called just after the event processing in order to execute special operations.
List<SelfDescribingJson>	getContexts()
Long	getTrueTimestamp()
AbstractEvent	trueTimestamp(Long trueTimestamp) Set the custom timestamp of the event.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.snowplowanalytics.snowplow.event.Event

getDataPayload

Field Detail

customContexts

public final List<SelfDescribingJson> customContexts

List of custom contexts associated to the event.

trueTimestamp

@Nullable
public Long trueTimestamp

Custom timestamp of the event.

Constructor Detail

AbstractEvent

public AbstractEvent()

Method Detail

contexts

@NonNull
public AbstractEvent contexts(@Nullable
                                       List<SelfDescribingJson> contexts)

Adds a list of contexts.

trueTimestamp

@NonNull
public AbstractEvent trueTimestamp(@Nullable
                                            Long trueTimestamp)

Set the custom timestamp of the event.

getContexts

@NonNull
public List<SelfDescribingJson> getContexts()

Specified by:

getContexts in interface Event

Returns:

the event custom context

getTrueTimestamp

@Nullable
public Long getTrueTimestamp()

Specified by:

getTrueTimestamp in interface Event

Returns:

the optional true events timestamp

beginProcessing

public void beginProcessing(@NonNull
                            com.snowplowanalytics.snowplow.internal.tracker.Tracker tracker)

Description copied from interface: Event

Hook method called just before the event processing in order to execute special operations.

Specified by:

beginProcessing in interface Event

endProcessing

public void endProcessing(@NonNull
                          com.snowplowanalytics.snowplow.internal.tracker.Tracker tracker)

Description copied from interface: Event

Hook method called just after the event processing in order to execute special operations.

Specified by:

endProcessing in interface Event