com.snowplowanalytics.snowplow.payload

Class SelfDescribingJson

java.lang.Object

com.snowplowanalytics.snowplow.payload.SelfDescribingJson

Direct Known Subclasses:

DeepLink, LifecycleEntity

public class SelfDescribingJson
extends Object

Returns a SelfDescribingJson object which will contain both the Schema and Data.

Constructor Summary

Constructors

Constructor and Description
SelfDescribingJson(String schema) Builds a SelfDescribingJson object
SelfDescribingJson(String schema, Object data) Builds a SelfDescribingJson object
SelfDescribingJson(String schema, SelfDescribingJson data) Builds a SelfDescribingJson object
SelfDescribingJson(String schema, TrackerPayload data) Builds a SelfDescribingJson object

Method Summary

Modifier and Type	Method and Description
long	getByteSize()
Map<String,Object>	getMap()
SelfDescribingJson	setData(Object data) Adds data to the SelfDescribingJson - Accepts a POJO
SelfDescribingJson	setData(SelfDescribingJson selfDescribingJson) Allows us to add data from one SelfDescribingJson into another without copying over the Schema.
SelfDescribingJson	setData(TrackerPayload trackerPayload) Adds data to the SelfDescribingJson - Accepts a TrackerPayload object
SelfDescribingJson	setSchema(String schema) Sets the Schema for the SelfDescribingJson
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SelfDescribingJson

public SelfDescribingJson(@NonNull
                          String schema)

Builds a SelfDescribingJson object

Parameters:

schema - the schema string

SelfDescribingJson

public SelfDescribingJson(@NonNull
                          String schema,
                          @NonNull
                          TrackerPayload data)

Builds a SelfDescribingJson object

Parameters:

schema - the schema string

data - to nest into the object as a TrackerPayload

SelfDescribingJson

public SelfDescribingJson(@NonNull
                          String schema,
                          @NonNull
                          SelfDescribingJson data)

Builds a SelfDescribingJson object

Parameters:

schema - the schema string

data - to nest into the object as a SelfDescribingJson

SelfDescribingJson

public SelfDescribingJson(@NonNull
                          String schema,
                          @NonNull
                          Object data)

Builds a SelfDescribingJson object

Parameters:

schema - the schema string

data - to nest into the object as a POJO

Method Detail

setSchema

@NonNull
public SelfDescribingJson setSchema(@NonNull
                                             String schema)

Sets the Schema for the SelfDescribingJson

Parameters:

schema - a valid schema string

Returns:

itself if it passes precondition checks

setData

@NonNull
public SelfDescribingJson setData(@Nullable
                                           TrackerPayload trackerPayload)

Adds data to the SelfDescribingJson - Accepts a TrackerPayload object

Parameters:

trackerPayload - the data to be added to the SelfDescribingJson

Returns:

itself

setData

@NonNull
public SelfDescribingJson setData(@Nullable
                                           Object data)

Adds data to the SelfDescribingJson - Accepts a POJO

Parameters:

data - the data to be added to the SelfDescribingJson

Returns:

itself

setData

@NonNull
public SelfDescribingJson setData(@Nullable
                                           SelfDescribingJson selfDescribingJson)

Allows us to add data from one SelfDescribingJson into another without copying over the Schema.

Parameters:

selfDescribingJson - the payload to add to the SelfDescribingJson

Returns:

itself

getMap

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

toString

@NonNull
public String toString()

Overrides:

toString in class Object

getByteSize

public long getByteSize()