Completion

sbt.internal.util.complete.Completion
See theCompletion companion object
sealed trait Completion

Represents a completion. The abstract members display and append are best explained with an example.

Assuming space-delimited tokens, processing this: am is are w could produce these Completions: Completion { display = "was"; append = "as" } Completion { display = "were"; append = "ere" } to suggest the tokens "was" and "were".

In this way, two pieces of information are preserved: 1) what needs to be appended to the current input if a completion is selected 2) the full token being completed, which is useful for presenting a user with choices to select

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class DisplayOnly
class Suggestion
class Token

Members list

Value members

Abstract methods

def append: String

The proposed suffix to append to the existing input to complete the last token in the input.

The proposed suffix to append to the existing input to complete the last token in the input.

Attributes

def display: String

The string to present to the user to represent the full token being suggested.

The string to present to the user to represent the full token being suggested.

Attributes

def isEmpty: Boolean

True if this Completion is suggesting the empty string.

True if this Completion is suggesting the empty string.

Attributes

Concrete methods

Appends the completions in o with the completions in this Completion.

Appends the completions in o with the completions in this Completion.

Attributes

final 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
final def x(o: Completions): Completions

Concrete fields

final lazy override val 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.