Packages

case object Void extends SpanOrVoid with Product with Serializable

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Void
  2. Serializable
  3. Product
  4. Equals
  5. SpanOrVoid
  6. HasStopOrVoid
  7. HasStartOrVoid
  8. SpanLike
  9. Writable
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clip(pos: Long): Long

    Clips a position to this span's boundary.

    Clips a position to this span's boundary. Note that the span's stop position is included. Thus the result is greater than or equal the start, and less than or equal (!) the stop.

    For the special cases of Span.All and Span.Void, this method returns the argument unchanged.

    pos

    the point to clip

    returns

    the clipped point

    Definition Classes
    VoidSpanLike
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. def compareStart(pos: Long): Int

    Compares the span's start to a given position

    Compares the span's start to a given position

    returns

    -1, if the span start lies before the query position, 1, if it lies after that position, or 0, if both are the same

    Definition Classes
    VoidSpanLike
  8. def compareStop(pos: Long): Int

    Compares the span's stop to a given position

    Compares the span's stop to a given position

    returns

    -1, if the span stop lies before the query position, 1, if it lies after that position, or 0, if both are the same

    Definition Classes
    VoidSpanLike
  9. def contains(that: SpanLike): Boolean

    Checks if another span lies within the span.

    Checks if another span lies within the span. The result is false if either of the two spans is void.

    that

    second span

    returns

    true, if that.start >= this.start && that.stop <= this.stop

    Definition Classes
    VoidSpanLike
  10. def contains(pos: Long): Boolean

    Checks if a position lies within the span.

    Checks if a position lies within the span. Note that this returns false if this.stop == pos.

    returns

    true, if start <= pos < stop

    Definition Classes
    VoidSpanLike
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def intersect(that: SpanLike): Void.type

    Construct the intersection between this and another span.

    Construct the intersection between this and another span. If the two spans are disjoint, the result will be empty. An empty result may be a Span if the two spans touched each other, or Span.Void if they did not touch each other. If either span is Span.All, the other span is returned. If either span is void, Span.Void will be returned.

    This method is commutative (a intersect b == b intersect a).

    that

    the span to form the intersection with

    returns

    the intersection span (possibly empty)

    Definition Classes
    VoidSpanOrVoidSpanLike
  15. def invert: All.type
  16. val isEmpty: Boolean

    Checks if the span is empty.

    Checks if the span is empty. A span is empty if it is a Span with start == stop or if it is void.

    returns

    true, if start == stop

    Definition Classes
    VoidSpanLike
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final val length: Long(0L)

    The span's length.

    The span's length. For a void span, this is zero, otherwise it is stop - start.

    Definition Classes
    VoidSpanOrVoid
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. val nonEmpty: Boolean

    Checks if the span is non empty.

    Checks if the span is non empty. This is exactly the opposite value of isEmpty.

    Definition Classes
    VoidSpanLike
  21. def nonEmptyOption: Option[Span]
    Definition Classes
    VoidSpanOrVoidHasStopOrVoidHasStartOrVoidSpanLike
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. def overlaps(that: SpanLike): Boolean

    Checks if a two spans overlap each other.

    Checks if a two spans overlap each other. Two spans overlap if the overlapping area is greater than or equal to 1. This implies that if either span is empty, the result will be false.

    This method is commutative (a overlaps b == b overlaps a).

    that

    second span

    returns

    true, if the spans overlap each other

    Definition Classes
    VoidSpanLike
  25. def productElementName(n: Int): String
    Definition Classes
    Product
  26. def productElementNames: Iterator[String]
    Definition Classes
    Product
  27. def productPrefix: String
    Definition Classes
    Void → Product
  28. def shift(delta: Long): Void.type

    Shifts the span, that is applies an offset to its start and stop.

    Shifts the span, that is applies an offset to its start and stop. For single sided open spans (Span.From and Span.Until) this alters the only bounded value. For Span.All and Span.Void this returns the object unchanged.

    delta

    the shift amount (the amount to be added to the span's positions)

    returns

    the shifted span

    Definition Classes
    VoidSpanOrVoidHasStopOrVoidHasStartOrVoidSpanLike
  29. def startOption: Option[Long]
    Definition Classes
    VoidSpanLike
  30. def startOrElse(default: => Long): Long
    Definition Classes
    VoidSpanLike
  31. def stopOption: Option[Long]
    Definition Classes
    VoidSpanLike
  32. def stopOrElse(default: => Long): Long
    Definition Classes
    VoidSpanLike
  33. def subtract(that: SpanLike): IndexedSeq[SpanOrVoid]

    Subtracts a given span from this span.

    Subtracts a given span from this span. Note that an empty span argument "cuts" this span, e.g. Span.all subtract Span(30,30) == Seq(Span.until(30),Span.from(30))

    that

    the span to subtract

    returns

    a collection of spans after the argument was subtracted. Unlike intersect, this method filters out empty spans, thus a span subtracted from itself produces an empty collection. if that is a Span, the result might be two disjoint spans.

    Definition Classes
    VoidSpanOrVoidSpanLike
  34. def subtract(that: Open): Void.type

    Subtracts a given open span from this span.

    Subtracts a given open span from this span.

    that

    the span to subtract

    returns

    the reduced span, possibly empty or void

    Definition Classes
    VoidSpanOrVoidSpanLike
  35. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  36. def toString(): String
    Definition Classes
    Void → AnyRef → Any
  37. def touches(that: SpanLike): Boolean

    Checks if a two spans overlap or touch each other.

    Checks if a two spans overlap or touch each other. Two spans touch each other if they either overlap or they share a common point with each other (this span's start or stop is that span's start or stop).

    This method is commutative (a touches b == b touches a).

    that

    second span

    returns

    true, if the spans touch each other

    Definition Classes
    VoidSpanLike
  38. def union(that: SpanLike): SpanLike

    Constructs a single span which contains both this and that span.

    Constructs a single span which contains both this and that span. If the two spans are disjoint, the result will be a span with start = min(this.start, that.start) and stop = max(this.stop, that.stop). If either span is void, the other span is returned. If either span is Span.All, Span.All will be returned.

    This method is commutative (a union b == b union a).

    that

    the span to form the union with

    returns

    the encompassing span

    Definition Classes
    VoidSpanLike
  39. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  40. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  41. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  42. def write(out: DataOutput): Unit
    Definition Classes
    VoidWritable

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from SpanOrVoid

Inherited from HasStopOrVoid

Inherited from HasStartOrVoid

Inherited from SpanLike

Inherited from Writable

Inherited from AnyRef

Inherited from Any

Ungrouped