Summary: Nested Classes | Ctors | Methods | Inherited Methods

Notification.Metric

---

Kotlin |Java

public static final class Notification.Metric
extends Object

java.lang.Object
↳	android.app.Notification.Metric

---

A metric, used with MetricStyle, and which has a value and a label.

Summary

Nested classes
class	Notification.Metric.FixedDate A metric value for showing a date.
class	Notification.Metric.FixedFloat Metric corresponding to a floating point value.
class	Notification.Metric.FixedInt Metric corresponding to an integer value.
class	Notification.Metric.FixedText Metric corresponding to a text value.
class	Notification.Metric.FixedTime A metric value for showing a clock time.
class	Notification.Metric.MetricValue A superclass for the various value types used by the Metric class.
class	Notification.Metric.TimeDifference This represents a timer, a stopwatch, or a countdown to an event.

Public constructors
Metric(Notification.Metric.MetricValue value, CharSequence label) Creates a Metric with the specified value and label.
Metric(Notification.Metric.MetricValue value, CharSequence label, int semanticStyle) Creates a Metric with the specified value, label, and semantic style.

Public methods
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
CharSequence	getLabel() A label for the metric.
int	getSemanticStyle() Applies semantics to the metric.
Notification.Metric.MetricValue	getValue() A value for the metric.
int	hashCode() Returns a hash code value for the object.
String	toString() Returns a string representation of the object.

Inherited methods

From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

Metric

public Metric (Notification.Metric.MetricValue value, 
                CharSequence label)

Creates a Metric with the specified value and label.

Parameters
value	Notification.Metric.MetricValue: one of the subclasses of MetricValue, such as FixedInt This value cannot be null.
label	CharSequence: metric label -- should be 10 characters or fewer. This value cannot be null.

Metric

public Metric (Notification.Metric.MetricValue value, 
                CharSequence label, 
                int semanticStyle)

Creates a Metric with the specified value, label, and semantic style.

Parameters
value	Notification.Metric.MetricValue: one of the subclasses of MetricValue, such as FixedInt This value cannot be null.
label	CharSequence: metric label -- should be 10 characters or fewer. This value cannot be null.
semanticStyle	int: semantic style applied to the metric. When the notification is promoted the metric value will be displayed (e.g. colored) according to this style. Value is one of the following: Notification.SEMANTIC_STYLE_UNSPECIFIED Notification.SEMANTIC_STYLE_INFO Notification.SEMANTIC_STYLE_SAFE Notification.SEMANTIC_STYLE_CAUTION Notification.SEMANTIC_STYLE_DANGER

Public methods

equals

public boolean equals (Object obj)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj	Object: the reference object with which to compare.

Returns
boolean	true if this object is the same as the obj argument; false otherwise.

getLabel

public CharSequence getLabel ()

A label for the metric.

The space allocated to this will depend on the number of metrics on the notification, but it's recommended to keep this to 10 characters or fewer.

Returns
CharSequence	This value cannot be null.

getSemanticStyle

public int getSemanticStyle ()

Applies semantics to the metric. When the notification is promoted the metric value will be displayed (e.g. colored) according to this style.

Returns
int	Value is one of the following: Notification.SEMANTIC_STYLE_UNSPECIFIED Notification.SEMANTIC_STYLE_INFO Notification.SEMANTIC_STYLE_SAFE Notification.SEMANTIC_STYLE_CAUTION Notification.SEMANTIC_STYLE_DANGER

getValue

public Notification.Metric.MetricValue getValue ()

A value for the metric.

Returns
Notification.Metric.MetricValue	This value cannot be null.

hashCode

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int	a hash code value for this object.

toString

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.