Builder (libhoney-java 0.0.1 API)

java.lang.Object
- io.honeycomb.Builder

```
public final class Builder
extends Object
```
Stores a Builder and some metadata, and can create a Event.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Builder()`
	`Builder(Builder other)` Constructs a new Builder with the same mappings and metadata as the specified Builder.
	`Builder(LibHoney libhoney)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Map<String,Object> fields)` Copies all of the field mappings from the specified map to this Builder.
`void`	`addDynField(String key, Callable function)` Associates the specified function with the specified key in the dynamic fields map.
`void`	`addDynFields(Map<String,Callable> dynFields)` Copies all of the dynamic field mappings from the specified map to this Builder.
`void`	`addField(String key, Object value)` Associates the specified value with the specified key in the fields map.
`void`	`addFromBuilder(Builder other)` Copies all of the field and dynamic field mappings from the specified Builder to this Builder.
`boolean`	`equals(Object obj)` Compares the specified object with this Builder for equality.
`String`	`getDataSet()` Returns the data set identifier for this Builder.
`Map<String,Callable>`	`getDynFields()` Returns dynamic fields for this Builder.
`Map<String,Object>`	`getFields()` Returns fields for this Builder.
`LibHoney`	`getLibHoney()` Returns a reference to LibHoney.
`int`	`getSampleRate()` Returns the sample rate for this Builder.
`String`	`getWriteKey()` Returns the write key for this Builder.
`int`	`hashCode()` Returns the hash code value for this Builder.
`boolean`	`isEmpty()` Returns true if this Builder contains no fields.
`protected void`	`linkLibHoney(LibHoney libhoney)` Stores a reference to LibHoney and applies LibHoney's metadata to this Builder.
`Event`	`newEvent()` Creates a Event from this Builder's fields.
`void`	`send()` Creates an Event, then sends with Transmission as a request, or as a dropped response if it should be dropped.
`void`	`sendNow(Map<String,Object> fields)` Immediately send a map of keys and values as a Event
`void`	`setDataSet(String dataSet)` Sets the data set
`void`	`setSampleRate(int sampleRate)` Sets the sample rate
`void`	`setWriteKey(String writeKey)` Sets the write key
`org.json.JSONObject`	`toJson()` Returns a JSON representation of this Builder.
`String`	`toString()` Returns a string representation of this Builder.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Builder
```
protected Builder()
```
  - Builder
```
public Builder(LibHoney libhoney)
```
  - Builder
```
public Builder(Builder other)
```
    Constructs a new Builder with the same mappings and metadata as the specified Builder.
    
    Parameters:
    
    other - the Builder whose mappings are to be stored in this map
- Method Detail
  - add
```
public void add(Map<String,Object> fields)
```
    Copies all of the field mappings from the specified map to this Builder.
    
    Parameters:
    
    fields - field mappings to be added to this Builder
  - addDynField
```
public void addDynField(String key,
                        Callable function)
```
    Associates the specified function with the specified key in the dynamic fields map.
    
    Parameters:
    
    key - key with which the specified function is to be associated
    
    function - function to be associated with the specified key
  - addDynFields
```
public void addDynFields(Map<String,Callable> dynFields)
```
    Copies all of the dynamic field mappings from the specified map to this Builder.
    
    Parameters:
    
    dynFields - dynamic field mappings to be added this Builder
  - addField
```
public void addField(String key,
                     Object value)
```
    Associates the specified value with the specified key in the fields map.
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    value - value to be associated with the specified key
  - addFromBuilder
```
public void addFromBuilder(Builder other)
```
    Copies all of the field and dynamic field mappings from the specified Builder to this Builder.
    
    Parameters:
    
    other - the Builder whose mappings are to be added to this map
  - equals
```
public boolean equals(Object obj)
```
    Compares the specified object with this Builder for equality. Returns true if the given object is also a Builder and the two Builders contain equal fields and metadata.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - Object to be compared for equality with this Builder
    
    Returns:
    
    true if the specified object is equal to this Builder
  - getDataSet
```
public String getDataSet()
```
    Returns the data set identifier for this Builder.
    
    Returns:
    
    the data set identifier for this Builder
  - getDynFields
```
public Map<String,Callable> getDynFields()
```
    Returns dynamic fields for this Builder.
    
    Returns:
    
    dynamic fields for this Builder
  - getFields
```
public Map<String,Object> getFields()
```
    Returns fields for this Builder.
    
    Returns:
    
    fields for this Builder
  - getLibHoney
```
public LibHoney getLibHoney()
```
    Returns a reference to LibHoney.
    
    Returns:
    
    a reference to LibHoney.
  - getSampleRate
```
public int getSampleRate()
```
    Returns the sample rate for this Builder.
    
    Returns:
    
    the sample rate for this Builder
  - getWriteKey
```
public String getWriteKey()
```
    Returns the write key for this Builder.
    
    Returns:
    
    the write key for this Builder
  - hashCode
```
public int hashCode()
```
    Returns the hash code value for this Builder.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the hash code value for this Builder
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if this Builder contains no fields. Does not check dynamic fields.
    
    Returns:
    
    true if this Builder contains no fields
  - linkLibHoney
```
protected void linkLibHoney(LibHoney libhoney)
```
    Stores a reference to LibHoney and applies LibHoney's metadata to this Builder.
    
    Parameters:
    
    libhoney - reference to LibHoney
  - newEvent
```
public Event newEvent()
```
    Creates a Event from this Builder's fields.
    
    Returns:
    
    a Event from this Builder's fields
  - send
```
public void send()
          throws HoneyException
```
    Creates an Event, then sends with Transmission as a request, or as a dropped response if it should be dropped.
    
    Throws:
    
    HoneyException - if there is something wrong with the request
  - sendNow
```
public void sendNow(Map<String,Object> fields)
             throws HoneyException
```
    Immediately send a map of keys and values as a Event
    
    Parameters:
    
    fields - field key
    
    Throws:
    
    HoneyException - if there is something wrong with the request
  - setDataSet
```
public void setDataSet(String dataSet)
```
    Sets the data set
    
    Parameters:
    
    dataSet - data set
  - setSampleRate
```
public void setSampleRate(int sampleRate)
```
    Sets the sample rate
    
    Parameters:
    
    sampleRate - sample rate
  - setWriteKey
```
public void setWriteKey(String writeKey)
```
    Sets the write key
    
    Parameters:
    
    writeKey - write key
  - toJson
```
public org.json.JSONObject toJson()
```
    Returns a JSON representation of this Builder.
    
    Returns:
    
    a JSON representation of this Builder
  - toString
```
public String toString()
```
    Returns a string representation of this Builder.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of this Builder

Class Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Builder

Builder

Method Detail

add

addDynField

addDynFields

addField

addFromBuilder

equals

getDataSet

getDynFields

getFields

getLibHoney

getSampleRate

getWriteKey

hashCode

isEmpty

linkLibHoney

newEvent

send

sendNow

setDataSet

setSampleRate

setWriteKey

toJson

toString