Notification.Metric.FixedFloat


public static final class Notification.Metric.FixedFloat
extends Notification.Metric.MetricValue

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


Metric corresponding to a floating point value.

Summary

Public constructors

FixedFloat(float value)

Creates a FixedFloat instance with no unit and 0 minimum and 3 maximum fractional digits.

FixedFloat(float value, CharSequence unit)

Creates a FixedFloat instance with 0 minimum and 2 maximum fractional digits.

FixedFloat(float value, CharSequence unit, int minFractionDigits, int maxFractionDigits)

Creates a FixedFloat instance.

Public methods

boolean equals(Object obj)

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

int getMaxFractionDigits()

Maximum number of fractional digits to display.

int getMinFractionDigits()

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.

Inherited methods

Public constructors

FixedFloat

public FixedFloat (float value)

Creates a FixedFloat instance with no unit and 0 minimum and 3 maximum fractional digits.

Parameters
value float

FixedFloat

public FixedFloat (float value, 
                CharSequence unit)

Creates a FixedFloat instance with 0 minimum and 2 maximum fractional digits.

Parameters
value float

unit CharSequence: optional unit for the value. Limit this to a few characters.
This value may be null.

FixedFloat

public FixedFloat (float value, 
                CharSequence unit, 
                int minFractionDigits, 
                int maxFractionDigits)

Creates a FixedFloat instance.

Parameters
value float

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 ERROR(/#LOWER_BOUND_FRACTION_DIGITS) and ERROR(/#UPPER_BOUND_FRACTION_DIGITS) inclusive

maxFractionDigits int: maximum number of factional digits to display (0-6 and >= minFractionDigits).
Value is between ERROR(/#LOWER_BOUND_FRACTION_DIGITS) and ERROR(/#UPPER_BOUND_FRACTION_DIGITS) inclusive

Throws
IllegalArgumentException if minFractionDigits or maxFractionDigits do not respect the specified constraints

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.

getMaxFractionDigits

public int getMaxFractionDigits ()

Maximum number of fractional digits to display.

Returns
int Value is between ERROR(/#LOWER_BOUND_FRACTION_DIGITS) and ERROR(/#UPPER_BOUND_FRACTION_DIGITS) inclusive

getMinFractionDigits

public int getMinFractionDigits ()

Minimum number of fractional digits to display.

Returns
int Value is between ERROR(/#LOWER_BOUND_FRACTION_DIGITS) and ERROR(/#UPPER_BOUND_FRACTION_DIGITS) inclusive

getUnit

public CharSequence getUnit ()

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.

Returns
CharSequence This value may be null.

getValue

public float getValue ()

The fractional value.

Returns
float

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.