FixedFloat
class FixedFloat : Notification.Metric.MetricValue
| kotlin.Any | ||
| ↳ | android.app.Notification.Metric.MetricValue | |
| ↳ | android.app.Notification.Metric.FixedFloat | |
Metric corresponding to a floating point value.
Summary
| Public constructors | |
|---|---|
FixedFloat(value: Float)Creates a |
|
FixedFloat(value: Float, unit: CharSequence?)Creates a |
|
FixedFloat(value: Float, unit: CharSequence?, minFractionDigits: Int, maxFractionDigits: Int)Creates a |
|
| Public methods | |
|---|---|
| Boolean |
Indicates whether some other object is "equal to" this one. |
| Int |
Maximum number of fractional digits to display. |
| Int |
Minimum number of fractional digits to display. |
| CharSequence? |
getUnit()The unit of measurement for the value, if required. |
| Float |
getValue()The fractional value. |
| Int |
hashCode()Returns a hash code value for the object. |
| String |
toString()Returns a string representation of the object. |
Public constructors
FixedFloat
FixedFloat(value: Float)
Creates a FixedFloat instance with no unit and 0 minimum and 2 maximum fractional digits.
FixedFloat
FixedFloat(
value: Float,
unit: CharSequence?)
Creates a FixedFloat instance with 0 minimum and 2 maximum fractional digits.
| Parameters | |
|---|---|
unit |
CharSequence?: optional unit for the value. Limit this to a few characters. This value may be null. |
FixedFloat
FixedFloat(
value: Float,
unit: CharSequence?,
minFractionDigits: Int,
maxFractionDigits: Int)
Creates a FixedFloat instance.
Note that the specified fraction digits might be ignored to make the text fit.
| Parameters | |
|---|---|
unit |
CharSequence?: optional unit for the value. Limit this to a few characters. This value may be null. |
minFractionDigits |
Int: minimum number of factional digits to display (0-6). Value is between #LOWER_BOUND_FRACTION_DIGITS and #UPPER_BOUND_FRACTION_DIGITS inclusive |
maxFractionDigits |
Int: maximum number of factional digits to display (0-6 and >= minFractionDigits). Value is between #LOWER_BOUND_FRACTION_DIGITS and #UPPER_BOUND_FRACTION_DIGITS inclusive |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if minFractionDigits or maxFractionDigits do not respect the specified constraints |
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. |
getMaxFractionDigits
fun getMaxFractionDigits(): Int
Maximum number of fractional digits to display.
| Return | |
|---|---|
Int |
Value is between #LOWER_BOUND_FRACTION_DIGITS and #UPPER_BOUND_FRACTION_DIGITS inclusive |
getMinFractionDigits
fun getMinFractionDigits(): Int
Minimum number of fractional digits to display.
| Return | |
|---|---|
Int |
Value is between #LOWER_BOUND_FRACTION_DIGITS and #UPPER_BOUND_FRACTION_DIGITS inclusive |
getUnit
fun getUnit(): CharSequence?
The unit of measurement for the value, if required.
This may not be shown to the user in all views.
The space allocated to this will be limited. It's recommended to limit this to just a few characters.
| Return | |
|---|---|
CharSequence? |
This value may 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. |