Package io.honeycomb.libhoney

Class EventFactory

java.lang.Object

io.honeycomb.libhoney.EventFactory

public class EventFactory
extends Object

This is used to generate Events with a shared set of properties. An instance can be constructed using HoneyClient.buildEventFactory(). Any properties declared on the EventFactory.Builder take precedence over ones from the original HoneyClient instance.

An instance of EventFactory is immutable and threadsafe, but a modifiable copy can be obtained with copy().

Note: If you develop with Honeycomb SDKs in other programming languages, this Event Factory is usually simply called a "Builder".

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EventFactory.Builder	Helper class to construct an EventFactory.

Method Summary

Modifier and Type	Method	Description
EventFactory.Builder	copy()	Creates a builder for a new factory, pre-populated with the fields and settings of this factory instance, that can be further customised.
Event	createEvent()	Returns an Event populated with the settings and fields of this factory instance.
void	send(Map<String,?> fields)	Provides a shortcut to sending an event by populating it with the settings and fields of this factory instance and adding the provided map of fields.

Methods inherited from class java.lang.Object

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

Method Detail

createEvent

public Event createEvent()

Returns an Event populated with the settings and fields of this factory instance.

Returns:

an event.

send

public void send(Map<String,?> fields)

Provides a shortcut to sending an event by populating it with the settings and fields of this factory instance and adding the provided map of fields. It is also subject to the factory's sampling rate.

Parameters:

fields - to provide to the event.

Throws:

IllegalArgumentException - if client-side validation fails, see HoneyClient's class documentation for the "Event Validation" rules.

copy

public EventFactory.Builder copy()

Creates a builder for a new factory, pre-populated with the fields and settings of this factory instance, that can be further customised.

Returns:

builder to create a new factory from.