com.snowplowanalytics.snowplow.configuration

Class GlobalContextsConfiguration

java.lang.Object

com.snowplowanalytics.snowplow.configuration.GlobalContextsConfiguration

All Implemented Interfaces:

Configuration, com.snowplowanalytics.snowplow.internal.globalcontexts.GlobalContextsConfigurationInterface, Serializable

public class GlobalContextsConfiguration
extends Object
implements Configuration, com.snowplowanalytics.snowplow.internal.globalcontexts.GlobalContextsConfigurationInterface

This class allows the setup of Global Contexts which are attached to selected events.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,GlobalContext>	contextGenerators

Constructor Summary

Constructors

Constructor and Description
GlobalContextsConfiguration(Map<String,GlobalContext> contextGenerators) Allows for the creation of a map of tags and associated GlobalContext generators.

Method Summary

Modifier and Type	Method and Description
boolean	add(String tag, GlobalContext contextGenerator) Add a GlobalContext generator to the configuration of the tracker.
GlobalContextsConfiguration	copy()
Set<String>	getTags()
GlobalContext	remove(String tag) Remove a GlobalContext generator from the configuration of the tracker.

Methods inherited from class java.lang.Object

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

Field Detail

contextGenerators

@NonNull
public final Map<String,GlobalContext> contextGenerators

Constructor Detail

GlobalContextsConfiguration

public GlobalContextsConfiguration(@Nullable
                                   Map<String,GlobalContext> contextGenerators)

Allows for the creation of a map of tags and associated GlobalContext generators. They are used by the tracker based on the filter settings defined on each GlobalContext.

Parameters:

contextGenerators - Map of Global Contexts generators.

Method Detail

getTags

@NonNull
public Set<String> getTags()

Specified by:

getTags in interface com.snowplowanalytics.snowplow.internal.globalcontexts.GlobalContextsConfigurationInterface

Returns:

Set of tags associated to added GlobalContexts.

add

public boolean add(@NonNull
                   String tag,
                   @NonNull
                   GlobalContext contextGenerator)

Add a GlobalContext generator to the configuration of the tracker.

Specified by:

add in interface com.snowplowanalytics.snowplow.internal.globalcontexts.GlobalContextsConfigurationInterface

Parameters:

tag - The label identifying the generator in the tracker.

contextGenerator - The GlobalContext generator.

Returns:

Whether the adding operation has succeeded.

remove

@Nullable
public GlobalContext remove(@NonNull
                                      String tag)

Remove a GlobalContext generator from the configuration of the tracker.

Specified by:

remove in interface com.snowplowanalytics.snowplow.internal.globalcontexts.GlobalContextsConfigurationInterface

Parameters:

tag - The label identifying the generator in the tracker.

Returns:

Whether the removing operation has succeded.

copy

@NonNull
public GlobalContextsConfiguration copy()

Specified by:

copy in interface Configuration