WordWrapper

Wraps strings on word boundaries to fit within a proscribed output width. The wrapped string may have a prefix or not; prefixes are useful for error messages, for instance. You tell a WordWrapper about a prefix by passing a non-empty prefix to the constructor.

Examples:

Unable to open file /usr/local/etc/wombat: No such file or directory

might appear like this without a prefix:

Unable to open file /usr/local/etc/wombat: No such file or
directory

and like this if the prefix is "myprog:"

myprog: Unable to open file /usr/local/etc/wombat: No such
file or directory

Alternatively, if the output width is shortened, the same message can be made to wrap something like this:

myprog: Unable to open file
/usr/local/etc/wombat:
No such file or
directory

Note how the wrapping logic will "tab" past the prefix on wrapped lines.

This method also supports the notion of an indentation level, which is independent of the prefix. A non-zero indentation level causes each line, including the first line, to be indented that many characters. Thus, initializing a WordWrapper object with an indentation value of 4 will cause each output line to be preceded by 4 blanks. (It's also possible to change the indentation character from a blank to any other character.

Notes

- The class does not do any special processing of tab characters. Embedded tab characters can have surprising (and unwanted) effects on the rendered output. - Wrapping an already wrapped string is an invitation to trouble.

wrapWidth: the number of characters after which to wrap each line
indentation: how many characters to indent
prefix: the prefix to use, or "" for none. Cannot be null.
ignore: set of characters to ignore when calculating wrapping. This feature can be useful when certain characters represent escape characters, and you intend to post-process the wrapped string.
indentChar: the indentation character to use.

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new WordWrapper(wrapWidth: Int = 79, indentation: Int = 0, prefix: String = "", ignore: Set[Char] = scala.this.Predef.Set.empty[Char], indentChar: Char = ' ')

wrapWidth
the number of characters after which to wrap each line
indentation
how many characters to indent
prefix
the prefix to use, or "" for none. Cannot be null.
ignore
set of characters to ignore when calculating wrapping. This feature can be useful when certain characters represent escape characters, and you intend to post-process the wrapped string.
indentChar
the indentation character to use.

Value Members

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
Any
final def ##(): Int

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

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

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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 ignore: Set[Char]

set of characters to ignore when calculating wrapping.
set of characters to ignore when calculating wrapping. This feature can be useful when certain characters represent escape characters, and you intend to post-process the wrapped string.
val indentChar: Char

the indentation character to use.
val indentation: Int

how many characters to indent
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val prefix: String

the prefix to use, or "" for none.
the prefix to use, or "" for none. Cannot be null.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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 wrap(s: String): String

Wrap a string, using the wrap width, prefix, indentation and indentation character that were specified to the WordWrapper constructor.
Wrap a string, using the wrap width, prefix, indentation and indentation character that were specified to the WordWrapper constructor. The resulting string may have embedded newlines in it.
s
the string to wrap
returns
the wrapped string
val wrapWidth: Int

the number of characters after which to wrap each line

case class WordWrapper(wrapWidth: Int = 79, indentation: Int = 0, prefix: String = "", ignore: Set[Char] = scala.this.Predef.Set.empty[Char], indentChar: Char = ' ') extends Product with Serializable

Examples:

Notes

Instance Constructors

new WordWrapper(wrapWidth: Int = 79, indentation: Int = 0, prefix: String = "", ignore: Set[Char] = scala.this.Predef.Set.empty[Char], indentChar: Char = ' ')

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val ignore: Set[Char]

val indentChar: Char

val indentation: Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val prefix: String

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

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def wrap(s: String): String

val wrapWidth: Int

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped