com.snowplowanalytics.snowplow.payload

Class TrackerPayload

java.lang.Object

com.snowplowanalytics.snowplow.payload.TrackerPayload

All Implemented Interfaces:

Payload

public class TrackerPayload
extends Object
implements Payload

Returns a standard Tracker Payload consisting of many key - pair values.

Constructor Summary

Constructors

Constructor and Description
TrackerPayload()

Method Summary

Modifier and Type	Method and Description
void	add(String key, Object value) Add a basic parameter.
void	add(String key, String value) Add a basic parameter.
void	addMap(Map<String,Object> map) Add all the mappings from the specified map.
void	addMap(Map map, Boolean base64_encoded, String type_encoded, String type_no_encoded) Add a map to the Payload with a key dependent on the base 64 encoding option you choose using the two keys provided.
long	getByteSize() Returns the byte size of a payload.
HashMap<String,Object>	getMap() Returns the Payload as a HashMap.
String	toString() Returns the Payload as a string.

Methods inherited from class java.lang.Object

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

Constructor Detail

TrackerPayload

public TrackerPayload()

Method Detail

add

public void add(@NonNull
                String key,
                @Nullable
                String value)

Description copied from interface: Payload

Add a basic parameter.

Specified by:

add in interface Payload

Parameters:

key - The parameter key

value - The parameter value as a String

add

public void add(@NonNull
                String key,
                @Nullable
                Object value)

Description copied from interface: Payload

Add a basic parameter.

Specified by:

add in interface Payload

Parameters:

key - The parameter key

value - The parameter value

addMap

public void addMap(@NonNull
                   Map<String,Object> map)

Description copied from interface: Payload

Add all the mappings from the specified map. The effect is the equivalent to that of calling add(String key, Object value) for each mapping for each key.

Specified by:

addMap in interface Payload

Parameters:

map - Mappings to be stored in this map

addMap

public void addMap(@NonNull
                   Map map,
                   @NonNull
                   Boolean base64_encoded,
                   @Nullable
                   String type_encoded,
                   @Nullable
                   String type_no_encoded)

Description copied from interface: Payload

Add a map to the Payload with a key dependent on the base 64 encoding option you choose using the two keys provided.

Specified by:

addMap in interface Payload

Parameters:

map - Mapping to be stored

base64_encoded - The option you choose to encode the data

type_encoded - The key that would be set if the encoding option was set to true

type_no_encoded - They key that would be set if the encoding option was set to false

getMap

@NonNull
public HashMap<String,Object> getMap()

Description copied from interface: Payload

Returns the Payload as a HashMap.

Specified by:

getMap in interface Payload

Returns:

A HashMap

toString

@NonNull
public String toString()

Description copied from interface: Payload

Returns the Payload as a string. This is essentially the toString from the ObjectNode used to store the Payload.

Specified by:

toString in interface Payload

Overrides:

toString in class Object

Returns:

A string value of the Payload.

getByteSize

public long getByteSize()

Description copied from interface: Payload

Returns the byte size of a payload.

Specified by:

getByteSize in interface Payload

Returns:

A long representing the byte size of the payload.