com.atlassian.util.profiling

Class MetricTag

java.lang.Object

com.atlassian.util.profiling.MetricTag

Direct Known Subclasses:

MetricTag.OptionalMetricTag, MetricTag.RequiredMetricTag

@Internal
 @Immutable
 @ParametersAreNonnullByDefault
public abstract class MetricTag
extends Object

A data class representing a single metric tag, as a key-value pair.

Since:

3.4

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetricTag.OptionalMetricTag Represents a metric tag that may or may not be considered when generating a metric.
static class	MetricTag.RequiredMetricTag

Field Summary

Fields

Modifier and Type	Field and Description
static String	FROM_PLUGIN_KEY_TAG_KEY
static String	INVOKER_PLUGIN_KEY_TAG_KEY
static MetricTag.RequiredMetricTag	SEND_ANALYTICS
static String	SUBCATEGORY
static String	UNDEFINED_TAG_VALUE

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getKey()
String	getValue()
int	hashCode()
static MetricTag.RequiredMetricTag	of(String key, boolean value)
static MetricTag.RequiredMetricTag	of(String key, int value)
static MetricTag.RequiredMetricTag	of(String key, String value) nullable value since 3.6.1
static MetricTag.OptionalMetricTag	optionalOf(String key, boolean value)
static MetricTag.OptionalMetricTag	optionalOf(String key, int value)
static MetricTag.OptionalMetricTag	optionalOf(String key, String value)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SEND_ANALYTICS

public static final MetricTag.RequiredMetricTag SEND_ANALYTICS

FROM_PLUGIN_KEY_TAG_KEY

public static final String FROM_PLUGIN_KEY_TAG_KEY

See Also:

Constant Field Values

INVOKER_PLUGIN_KEY_TAG_KEY

public static final String INVOKER_PLUGIN_KEY_TAG_KEY

See Also:

Constant Field Values

SUBCATEGORY

public static final String SUBCATEGORY

See Also:

Constant Field Values

UNDEFINED_TAG_VALUE

public static final String UNDEFINED_TAG_VALUE

See Also:

Constant Field Values

Method Detail

getKey

@Nonnull
public String getKey()

getValue

@Nonnull
public String getValue()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

of

@Nonnull
public static MetricTag.RequiredMetricTag of(String key,
                                                      @Nullable
                                                      String value)

nullable value since 3.6.1

Since:

3.4.2

of

@Nonnull
public static MetricTag.RequiredMetricTag of(String key,
                                                      int value)

Since:

3.4.2

of

@Nonnull
public static MetricTag.RequiredMetricTag of(String key,
                                                      boolean value)

Since:

3.4.2

optionalOf

@Nonnull
public static MetricTag.OptionalMetricTag optionalOf(String key,
                                                              @Nullable
                                                              String value)

Since:

4.0.0

optionalOf

@Nonnull
public static MetricTag.OptionalMetricTag optionalOf(String key,
                                                              int value)

Since:

4.0.0

optionalOf

@Nonnull
public static MetricTag.OptionalMetricTag optionalOf(String key,
                                                              boolean value)

Since:

4.0.0