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.

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?
penalty: Does this split overflow the column limit?
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, ignoreIf: Boolean = false, indents: Vector[Indent[Length]] = Vector.empty[Indent[Length]], policy: Policy = NoPolicy, penalty: Boolean = false, 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?
penalty
Does this split overflow the column limit?
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 adapt(formatToken: FormatToken): 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 ignoreIf: Boolean
val indentation: String
val indents: Vector[Indent[Length]]

Does this add indentation?
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def length: Int
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
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val optimalAt: Option[OptimalToken]
val penalty: Boolean

Does this split overflow the column limit?
val policy: Policy

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

Definition Classes
AnyRef
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(length: Length, expire: Token, expiresOn: ExpiresOn): Split
def withOptimalToken(token: Token, killOnFail: Boolean = false): Split
def withOptimalToken(token: Option[Token]): Split
def withPenalty(penalty: Int): Split
def withPolicy(newPolicy: Policy): Split

Related Doc: package internal

case class Split(modification: Modification, cost: Int, ignoreIf: Boolean = false, indents: Vector[Indent[Length]] = Vector.empty[Indent[Length]], policy: Policy = NoPolicy, penalty: Boolean = false, optimalAt: Option[OptimalToken] = None)(implicit line: Line) extends Product with Serializable

Instance Constructors

new Split(modification: Modification, cost: Int, ignoreIf: Boolean = false, indents: Vector[Indent[Length]] = Vector.empty[Indent[Length]], policy: Policy = NoPolicy, penalty: Boolean = false, optimalAt: Option[OptimalToken] = None)(implicit line: Line)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def adapt(formatToken: FormatToken): 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 ignoreIf: Boolean

val indentation: String

val indents: Vector[Indent[Length]]

final def isInstanceOf[T0]: Boolean

def length: Int

implicit val line: Line

val modification: Modification

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val optimalAt: Option[OptimalToken]

val penalty: Boolean

val policy: Policy

def sameSplit(other: Split): Boolean

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

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

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

def withOptimalToken(token: Option[Token]): Split

def withPenalty(penalty: Int): Split

def withPolicy(newPolicy: Policy): Split

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped