Updater/io.github.vxrpenter.updater.priority/Priority

Priority

value class Priority(rawValue: Double) : Comparable<Priority> (source)

Represents the priority of a value/task.

Negative and positive priorities are possible as they are all converted to Double for comparisons. You are also able to convert Longs to priority but note that they will also be converted to Double.

Constructors

Priority

constructor(rawValue: Double)

Types

Companion

object Companion

Functions

compareTo

open operator override fun compareTo(other: Priority): Int

div

operator fun div(scale: Double): Priority

operator fun div(scale: Int): Priority

Returns a priority whose value is this priority value divided by the given scale number.

isNegative

fun isNegative(): Boolean

Returns true if the priority value is less than zero.

isPositive

fun isPositive(): Boolean

Returns true if the priority value is greater than zero.

minus

operator fun minus(other: Priority): Priority

Returns priority whose value is the difference between this ann other priority values.

plus

operator fun plus(other: Priority): Priority

Returns priority whose value is the sum of this ann other priority values.

times

operator fun times(scale: Double): Priority

Returns priority whose value is the priority value, multiplied by the given scale number

operator fun times(scale: Int): Priority

Returns priority whose value is the priority value, multiplied by the given scale number.

toDouble

fun toDouble(): Double

Converts the priority into a double

toInt

fun toInt(): Int

Converts the priority into an integer

toLong

fun toLong(): Long

Converts the priority into a long