org.davidmoten.text.utils

Class WordWrap

java.lang.Object

org.davidmoten.text.utils.WordWrap

public final class WordWrap
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WordWrap.Builder Provides method chaining for specifying parameters to word wrap.

Field Summary

Fields

Modifier and Type	Field and Description
static Set<Character>	SPECIAL_WORD_CHARS_SET_DEFAULT

Method Summary

Modifier and Type	Method and Description
static WordWrap.Builder	from(CharSequence text) Sets the the source to be wrapped and returns a builder to specify more parameters.
static WordWrap.Builder	from(File file, Charset charset) Sets the source to be wrapped and the character set to be used to read it.
static WordWrap.Builder	from(InputStream in, Charset charset) Sets the source to be wrapped and the character set to be used to read it.
static WordWrap.Builder	from(Reader reader) Sets the source to be wrapped and returns a builder to specify more parameters.
static WordWrap.Builder	fromClasspath(String resource, Charset charset) Sets the source to be wrapped as a classpath resource to be read using the given character set.
static WordWrap.Builder	fromClasspathUtf8(String resource) Sets the source to be wrapped as a classpath resource which will be read using the UTF-8 character set.
static WordWrap.Builder	fromUtf8(InputStream in) Sets the source to be wrapped.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SPECIAL_WORD_CHARS_SET_DEFAULT

public static final Set<Character> SPECIAL_WORD_CHARS_SET_DEFAULT

Method Detail

from

public static WordWrap.Builder from(Reader reader)

Sets the source to be wrapped and returns a builder to specify more parameters.

Parameters:

reader - source to be wrapped

Returns:

builder

fromClasspathUtf8

public static WordWrap.Builder fromClasspathUtf8(String resource)

Sets the source to be wrapped as a classpath resource which will be read using the UTF-8 character set. Returns a builder to specify more parameters. Uses an 8192 byte buffer for reading.

Parameters:

resource - source to be wrapped as a classpath resource

Returns:

builder

fromClasspath

public static WordWrap.Builder fromClasspath(String resource,
                                             Charset charset)

Sets the source to be wrapped as a classpath resource to be read using the given character set. Returns a builder to specify more parameters. Uses an 8192 byte buffer for reading.

Parameters:

resource - classpath resource name

charset - charset to use for reading

Returns:

builder

from

public static WordWrap.Builder from(CharSequence text)

Sets the the source to be wrapped and returns a builder to specify more parameters. Uses an 8192 byte buffer for reading.

Parameters:

text - text to be wrapped

Returns:

builder

fromUtf8

public static WordWrap.Builder fromUtf8(InputStream in)

Sets the source to be wrapped. Returns a builder to specify more parameters. Uses an 8192 byte buffer for reading.s

Parameters:

in - source to be wrapped

Returns:

builder

from

public static WordWrap.Builder from(InputStream in,
                                    Charset charset)

Sets the source to be wrapped and the character set to be used to read it. Uses an 8192 byte buffer for reading. Returns a builder to specify more parameters.

Parameters:

in - source to be wrapped

charset - encoding

Returns:

builder

from

public static WordWrap.Builder from(File file,
                                    Charset charset)

Sets the source to be wrapped and the character set to be used to read it. Uses an 8192 byte buffer for reading. Returns a builder to specify more parameters.

Parameters:

file - file to be read

charset - charset of the text in the source file

Returns:

builder