net.openhft.chronicle.core.internal.analytics

Enum MuteBuilder

java.lang.Object

java.lang.Enum<MuteBuilder>

net.openhft.chronicle.core.internal.analytics.MuteBuilder

All Implemented Interfaces:

Serializable, Comparable<MuteBuilder>, AnalyticsFacade.Builder

public enum MuteBuilder
extends Enum<MuteBuilder>
implements AnalyticsFacade.Builder

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
@NotNull AnalyticsFacade	build() Creates and returns a new Analytics instance for this Builder.
AnalyticsFacade.Builder	putEventParameter(@NotNull String key, @NotNull String value) Associates the provided value with the provided key in this builder's event parameters.
AnalyticsFacade.Builder	putUserProperty(@NotNull String key, @NotNull String value) Associates the provided value with the provided key in this builder's user properties.
static MuteBuilder	valueOf(String name) Returns the enum constant of this type with the specified name.
static MuteBuilder[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
AnalyticsFacade.Builder	withClientIdFileName(@NotNull String clientIdFileName) Specifies a custom file name to use when storing a persistent client id used to identify returning users.
AnalyticsFacade.Builder	withDebugLogger(@NotNull Consumer<? super String> debugLogger) Specifies a custom logger that will receive debug messages.
AnalyticsFacade.Builder	withErrorLogger(@NotNull Consumer<? super String> errorLogger) Specifies a custom logger that will receive error messages.
AnalyticsFacade.Builder	withFrequencyLimit(int messages, long duration, @NotNull TimeUnit timeUnit) Limits the frequency by which events can be sent upstream to Google Analytics.
AnalyticsFacade.Builder	withReportDespiteJUnit() Specifies that reporting shall be made even though JUnit test classes are available to the classloader.
AnalyticsFacade.Builder	withUrl(@NotNull String url) Specifies a custom URL to use when connecting to Google Analytics.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final MuteBuilder INSTANCE

Method Detail

values

public static MuteBuilder[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MuteBuilder c : MuteBuilder.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MuteBuilder valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

putUserProperty

public AnalyticsFacade.Builder putUserProperty(@NotNull
                                               @NotNull String key,
                                               @NotNull
                                               @NotNull String value)

Description copied from interface: AnalyticsFacade.Builder

Associates the provided value with the provided key in this builder's user properties. If the builder previously contained an association for the key, the old value is replaced by the provided value.

The key will be used as a Google Analytics "user property" key with the associated value.

Specified by:

putUserProperty in interface AnalyticsFacade.Builder

Parameters:

key - to associate

value - to associate with the key

Returns:

this builder

putEventParameter

public AnalyticsFacade.Builder putEventParameter(@NotNull
                                                 @NotNull String key,
                                                 @NotNull
                                                 @NotNull String value)

Description copied from interface: AnalyticsFacade.Builder

Associates the provided value with the provided key in this builder's event parameters. If the builder previously contained an association for the key, the old value is replaced by the provided value.

The key will be used as a Google Analytics "event parameter" key with the associated value.

Specified by:

putEventParameter in interface AnalyticsFacade.Builder

Parameters:

key - to associate

value - to associate with the key

Returns:

this builder

withFrequencyLimit

public AnalyticsFacade.Builder withFrequencyLimit(int messages,
                                                  long duration,
                                                  @NotNull
                                                  @NotNull TimeUnit timeUnit)

Description copied from interface: AnalyticsFacade.Builder

Limits the frequency by which events can be sent upstream to Google Analytics.

Events that are posted within the provided time limit, counted from the time the last message was successfully attempted upstream, are silently dropped.

Thus, the highest rate of messages sent upstream can be calculated using the following function <p> 1.0d/timeUnit.toSeconds(duration) <p> which yields messages per second.

Specified by:

withFrequencyLimit in interface AnalyticsFacade.Builder

Parameters:

messages - max number of messages to send per duration

duration - minimum duration between upstream messages.

timeUnit - for the provided duration.

Returns:

this builder

withErrorLogger

public AnalyticsFacade.Builder withErrorLogger(@NotNull
                                               @NotNull Consumer<? super String> errorLogger)

Description copied from interface: AnalyticsFacade.Builder

Specifies a custom logger that will receive error messages. For example, failed HTTP communications.

The default logger is System.err::println, i.e. messages will be output to the error console.

The actual messages sent to the error logger are unspecified and shall not be acted on by logic.

Specified by:

withErrorLogger in interface AnalyticsFacade.Builder

Parameters:

errorLogger - to use for error messages.

Returns:

this builder

withDebugLogger

public AnalyticsFacade.Builder withDebugLogger(@NotNull
                                               @NotNull Consumer<? super String> debugLogger)

Description copied from interface: AnalyticsFacade.Builder

Specifies a custom logger that will receive debug messages. For example, HTTP messages sent back and forth.

The default logger is s -> {}, i.e. messages will be discarded.

The actual messages sent to the debug logger are unspecified and shall not be acted on by logic.

Specified by:

withDebugLogger in interface AnalyticsFacade.Builder

Parameters:

debugLogger - to use for debug messages.

Returns:

this builder

withClientIdFileName

public AnalyticsFacade.Builder withClientIdFileName(@NotNull
                                                    @NotNull String clientIdFileName)

Description copied from interface: AnalyticsFacade.Builder

Specifies a custom file name to use when storing a persistent client id used to identify returning users.

By default, a file named "chronicle.analytics.client.id" located in the user's home directory will be used.

Specified by:

withClientIdFileName in interface AnalyticsFacade.Builder

Parameters:

clientIdFileName - used to store the persistent client id.

Returns:

this builder

withUrl

public AnalyticsFacade.Builder withUrl(@NotNull
                                       @NotNull String url)

Description copied from interface: AnalyticsFacade.Builder

Specifies a custom URL to use when connecting to Google Analytics.

By default, the URL "https://www.google-analytics.com/mp/collect" will be used.

Specified by:

withUrl in interface AnalyticsFacade.Builder

Parameters:

url - used for remote connection

Returns:

this builder

withReportDespiteJUnit

public AnalyticsFacade.Builder withReportDespiteJUnit()

Description copied from interface: AnalyticsFacade.Builder

Specifies that reporting shall be made even though JUnit test classes are available to the classloader.

By default, no reporting will be done if either of the classes `org.junit.jupiter.api.Test` or `org.junit.Test` are available to the classloader.

Specified by:

withReportDespiteJUnit in interface AnalyticsFacade.Builder

Returns:

this builder

build

@NotNull
public @NotNull AnalyticsFacade build()

Description copied from interface: AnalyticsFacade.Builder

Creates and returns a new Analytics instance for this Builder.

Specified by:

build in interface AnalyticsFacade.Builder

Returns:

a new Analytics instance for this Builder