Segment
class Segment
| kotlin.Any | |
| ↳ | android.app.Notification.ProgressStyle.Segment |
A segment of the progress bar, which defines its length and color. Segments allow for creating progress bars with multiple colors or sections to represent different stages or categories of progress. For example, Traffic conditions along a navigation journey.
Summary
| Public constructors | |
|---|---|
|
Create a segment with a non-zero length. |
|
| Public methods | |
|---|---|
| Boolean |
Indicates whether some other object is "equal to" this one. |
| Int |
getColor()Returns the color of this Segment. |
| Int |
getId()Gets the id of this Segment. |
| Int |
The length of this Segment within the progress bar. |
| Int |
hashCode()Returns a hash code value for the object. |
| Notification.ProgressStyle.Segment |
Optional color of this Segment |
| Notification.ProgressStyle.Segment |
Optional ID used to uniquely identify the element across updates. |
Public constructors
Segment
Segment(length: Int)
Create a segment with a non-zero length.
| Parameters | |
|---|---|
length |
Int: See getLength Value is 1 or greater |
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. |
getLength
fun getLength(): Int
The length of this Segment within the progress bar. This value has no units, it is just relative to the length of other segments, and the value provided to ProgressStyle.setProgress.
| Return | |
|---|---|
Int |
Value is 1 or greater |
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. |
setColor
fun setColor(color: Int): Notification.ProgressStyle.Segment
Optional color of this Segment
| Return | |
|---|---|
Notification.ProgressStyle.Segment |
This value cannot be null. |
setId
fun setId(id: Int): Notification.ProgressStyle.Segment
Optional ID used to uniquely identify the element across updates. The default is 0.
| Return | |
|---|---|
Notification.ProgressStyle.Segment |
This value cannot be null. |