TaskProgressParams

sbt.internal.bsp.TaskProgressParams
See theTaskProgressParams companion object
final class TaskProgressParams extends Serializable

Value parameters

data

Optional metadata about the task.

dataKind

Kind of data to expect in the data field.

eventTime

Optional timestamp of when the event started in milliseconds since Epoch.

message

Message describing the task progress.

progress

If known, completed amount of work units in this task.

taskId

Unique id of the task with optional reference to parent task id.

total

If known, total amount of work units in this task.

unit

Name of a work unit. For example, "files" or "tests". May be empty.

Attributes

Companion
object
Graph
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

override def equals(o: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any
override def hashCode: Int

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
Any
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any
def withData(data: Option[JValue]): TaskProgressParams
def withData(data: JValue): TaskProgressParams
def withDataKind(dataKind: Option[String]): TaskProgressParams
def withDataKind(dataKind: String): TaskProgressParams
def withEventTime(eventTime: Option[Long]): TaskProgressParams
def withEventTime(eventTime: Long): TaskProgressParams
def withMessage(message: Option[String]): TaskProgressParams
def withMessage(message: String): TaskProgressParams
def withProgress(progress: Option[Long]): TaskProgressParams
def withProgress(progress: Long): TaskProgressParams
def withTotal(total: Option[Long]): TaskProgressParams
def withTotal(total: Long): TaskProgressParams
def withUnit(unit: Option[String]): TaskProgressParams
def withUnit(unit: String): TaskProgressParams

Concrete fields

val data: Option[JValue]
val dataKind: Option[String]
val eventTime: Option[Long]
val message: Option[String]
val progress: Option[Long]
val taskId: TaskId
val total: Option[Long]
val unit: Option[String]