Metric
class Metric
| kotlin.Any | |
| ↳ | android.app.Notification.Metric |
A metric, used with MetricStyle, and which has a value and a label.
Summary
| Nested classes | |
|---|---|
|
A metric value for showing a date. |
|
|
Metric corresponding to a floating point value. |
|
|
Metric corresponding to an integer value. |
|
|
Metric corresponding to a text value. |
|
|
A metric value for showing a clock time. |
|
| abstract |
A superclass for the various value types used by the |
|
This represents a timer, a stopwatch, or a countdown to an event. |
|
| Public constructors | |
|---|---|
Metric(value: Notification.Metric.MetricValue, label: CharSequence)Creates a Metric with the specified value and label. |
|
Metric(value: Notification.Metric.MetricValue, label: CharSequence, semanticStyle: Int)Creates a Metric with the specified value, label, and semantic style. |
|
| Public methods | |
|---|---|
| Boolean |
Indicates whether some other object is "equal to" this one. |
| CharSequence |
getLabel()A label for the metric. |
| Int |
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. |
Public constructors
Metric
Metric(
value: Notification.Metric.MetricValue,
label: CharSequence)
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
Metric(
value: Notification.Metric.MetricValue,
label: CharSequence,
semanticStyle: Int)
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: |
Public methods
equals
fun equals(other: Any?): Boolean
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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 |
the reference object with which to compare. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getLabel
fun getLabel(): CharSequence
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.
| Return | |
|---|---|
CharSequence |
This value cannot be null. |
getSemanticStyle
fun getSemanticStyle(): Int
Applies semantics to the metric. When the notification is promoted the metric value will be displayed (e.g. colored) according to this style.
| Return | |
|---|---|
Int |
Value is one of the following: |
getValue
fun getValue(): Notification.Metric.MetricValue
A value for the metric.
| Return | |
|---|---|
Notification.Metric.MetricValue |
This value cannot be null. |
hashCode
fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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.
| Return | |
|---|---|
Int |
a hash code value for this object. |
toString
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |