Split

A Split is the whitespace between two non-whitespace tokens.

Consider a split to be an edge in a search graph and FormatToken are the nodes.

NB: there's a historical inconsistency in how splits are sorted; when they are initially considered, cost is the primary factor (and hence, because of stable sort, earlier split with the same cost will take precedence). However, when a search state is added into the priority queue, preference is given to states with lower cost, further token and, unlike above, a LATER line defining the split.

A possible reason for the latter is to give those "secondary" splits a chance to move through the BestFirstSearch algorithm, as otherwise a sequence of primary splits might end up as the winning solution even if it exceeds the maxColumn margins, because a secondary split was deemed unlikely to win and moved to a backup priority queue.

modification: Is this a space, no space, newline or 2 newlines?
cost: How good is this output? Lower is better.
indents: Does this add indentation?
policy: How does this split affect other later splits?
line: For debugging, to retrace from which case in Router this split originates.

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new Split(modification: Modification, cost: Int, tag: SplitTag = SplitTag.Active, activeTag: SplitTag = SplitTag.Active, indents: Seq[Indent] = Seq.empty, policy: Policy = NoPolicy, optimalAt: Option[OptimalToken] = None)(implicit line: Line)

modification
Is this a space, no space, newline or 2 newlines?
cost
How good is this output? Lower is better.
indents
Does this add indentation?
policy
How does this split affect other later splits?
line
For debugging, to retrace from which case in Router this split originates.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def activateFor(tag: SplitTag): Split
val activeTag: SplitTag
def adapt(formatToken: FormatToken): Split
def andThenPolicy(newPolicy: Policy): Split
def andThenPolicyOpt(newPolicy: ⇒ Option[Policy]): Split
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val cost: Int

How good is this output? Lower is better.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val indentation: String
val indents: Seq[Indent]

Does this add indentation?
def isActive: Boolean

Annotations
@inline()
def isIgnored: Boolean

Annotations
@inline()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def length: Int

Annotations
@inline()
implicit val line: Line

For debugging, to retrace from which case in Router this split originates.
val modification: Modification

Is this a space, no space, newline or 2 newlines?
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def notIf(flag: Boolean): Split

Annotations
@inline()
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def onlyFor(tag: SplitTag, ignore: Boolean = false): Split
def onlyIf(flag: Boolean): Split
val optimalAt: Option[OptimalToken]
def orElsePolicy(newPolicy: Policy): Split
val policy: Policy

How does this split affect other later splits?
def switch(switchObject: AnyRef): Split
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val tag: SplitTag
def toString(): String

Definition Classes
Split → AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def withIndent(indent: ⇒ Indent): Split
def withIndent(length: ⇒ Length, expire: ⇒ Token, when: ExpiresOn): Split
def withIndentOpt(indent: ⇒ Option[Indent]): Split
def withIndentOpt(length: ⇒ Length, expire: Option[Token], when: ExpiresOn): Split
def withIndents(indents: Seq[Indent]): Split
def withOptimalAt(optimalAt: ⇒ Option[OptimalToken]): Split
def withOptimalToken(token: ⇒ Token, killOnFail: Boolean = false): Split
def withOptimalTokenOpt(token: ⇒ Option[Token], killOnFail: Boolean = false): Split
def withPenalty(penalty: Int): Split
def withPolicy(newPolicy: ⇒ Policy, ignore: Boolean = false)(implicit line: Line): Split
def withPolicyOpt(newPolicy: ⇒ Option[Policy])(implicit line: Line): Split
def withSingleLine(expire: Token, exclude: ⇒ Set[Range] = Set.empty, killOnFail: Boolean = false)(implicit line: Line): Split
def withSingleLineAndOptimal(expire: Token, optimal: Token, exclude: ⇒ Set[Range] = Set.empty, killOnFail: Boolean = false)(implicit line: Line): Split
def withSingleLineNoOptimal(expire: Token, exclude: ⇒ Set[Range] = Set.empty)(implicit line: Line): Split
def withSingleLineOpt(expire: Option[Token], exclude: ⇒ Set[Range] = Set.empty, killOnFail: Boolean = false)(implicit line: Line): Split

Related Docs: object Split | package internal

case class Split(modification: Modification, cost: Int, tag: SplitTag = SplitTag.Active, activeTag: SplitTag = SplitTag.Active, indents: Seq[Indent] = Seq.empty, policy: Policy = NoPolicy, optimalAt: Option[OptimalToken] = None)(implicit line: Line) extends Product with Serializable

Instance Constructors

new Split(modification: Modification, cost: Int, tag: SplitTag = SplitTag.Active, activeTag: SplitTag = SplitTag.Active, indents: Seq[Indent] = Seq.empty, policy: Policy = NoPolicy, optimalAt: Option[OptimalToken] = None)(implicit line: Line)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def activateFor(tag: SplitTag): Split

val activeTag: SplitTag

def adapt(formatToken: FormatToken): Split

def andThenPolicy(newPolicy: Policy): Split

def andThenPolicyOpt(newPolicy: ⇒ Option[Policy]): Split

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val cost: Int

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val indentation: String

val indents: Seq[Indent]

def isActive: Boolean

def isIgnored: Boolean

final def isInstanceOf[T0]: Boolean

def length: Int

implicit val line: Line

val modification: Modification

final def ne(arg0: AnyRef): Boolean

def notIf(flag: Boolean): Split

final def notify(): Unit

final def notifyAll(): Unit

def onlyFor(tag: SplitTag, ignore: Boolean = false): Split

def onlyIf(flag: Boolean): Split

val optimalAt: Option[OptimalToken]

def orElsePolicy(newPolicy: Policy): Split

val policy: Policy

def switch(switchObject: AnyRef): Split

final def synchronized[T0](arg0: ⇒ T0): T0

val tag: SplitTag

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withIndent(indent: ⇒ Indent): Split

def withIndent(length: ⇒ Length, expire: ⇒ Token, when: ExpiresOn): Split

def withIndentOpt(indent: ⇒ Option[Indent]): Split

def withIndentOpt(length: ⇒ Length, expire: Option[Token], when: ExpiresOn): Split

def withIndents(indents: Seq[Indent]): Split

def withOptimalAt(optimalAt: ⇒ Option[OptimalToken]): Split

def withOptimalToken(token: ⇒ Token, killOnFail: Boolean = false): Split

def withOptimalTokenOpt(token: ⇒ Option[Token], killOnFail: Boolean = false): Split

def withPenalty(penalty: Int): Split

def withPolicy(newPolicy: ⇒ Policy, ignore: Boolean = false)(implicit line: Line): Split

def withPolicyOpt(newPolicy: ⇒ Option[Policy])(implicit line: Line): Split

def withSingleLine(expire: Token, exclude: ⇒ Set[Range] = Set.empty, killOnFail: Boolean = false)(implicit line: Line): Split

def withSingleLineAndOptimal(expire: Token, optimal: Token, exclude: ⇒ Set[Range] = Set.empty, killOnFail: Boolean = false)(implicit line: Line): Split

def withSingleLineNoOptimal(expire: Token, exclude: ⇒ Set[Range] = Set.empty)(implicit line: Line): Split

def withSingleLineOpt(expire: Option[Token], exclude: ⇒ Set[Range] = Set.empty, killOnFail: Boolean = false)(implicit line: Line): Split

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped