Package de.xima.fc.common.text.newline

Class Newlines

java.lang.Object

de.xima.fc.common.text.newline.Newlines

public final class Newlines
extends Object

Utility class for Newline.

Since:

8.2.0

Method Summary

Modifier and Type	Method	Description
static NewlineProcessor	map(NewlineProcessor processor, UnaryOperator<String> mapper)	Creates a newline processor that behaves like the given processor, but maps each line using the given mapper.
static NewlineProcessor	newlineAsSeparator(Newline... newlines)	Creates a newline processor that interprets the newlines as a separator.
static NewlineProcessor	newlineAsSeparator(Iterable<? extends Newline> newlines)	Creates a newline processor that interprets the newlines as a separator.
static NewlineProcessor	newlineAsTerminator(Newline... newlines)	Creates a newline processor that interprets the newlines as a terminator.
static NewlineProcessor	newlineAsTerminator(Iterable<? extends Newline> newlines)	Creates a newline processor that interprets the newlines as a terminator.
static NewlineProcessor	newlineFiltering(NewlineProcessor processor, Predicate<? super String> filter)	Creates a newline processor that behaves like the given processor, but filters out lines that do not match the given predicate.
static Newline	newlineOfToken(String token)
static NewlineProcessor	newlineTokenAsSeparator(Iterable<String> tokens)	Creates a newline processor that interprets the newlines as a separator.
static NewlineProcessor	newlineTokenAsSeparator(String... tokens)	Creates a newline processor that interprets the newlines as a separator.
static NewlineProcessor	newlineTokenAsTerminator(Iterable<String> tokens)	Creates a newline processor that interprets the newlines as a terminator.
static NewlineProcessor	newlineTokenAsTerminator(String... tokens)	Creates a newline processor that interprets the newlines as a terminator.
static Writer	transformingWriter(Writer writer, Newline target, Newline... source)	Creates a writer with the same content as the given write, but with all source newlines replaced by the given target newline.

Methods inherited from class java.lang.Object

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

Method Detail

map

public static NewlineProcessor map(NewlineProcessor processor,
                                   UnaryOperator<String> mapper)

Creates a newline processor that behaves like the given processor, but maps each line using the given mapper. When splitting, the lines are mapped before being returned. When formatting, the lines are mapped before being formatted.

Parameters:

processor - The processor to wrap.

mapper - The mapper to apply.

Returns:

A newline processor that behaves like the given processor, but maps each line using the given mapper.

newlineAsSeparator

public static NewlineProcessor newlineAsSeparator(Iterable<? extends Newline> newlines)

Creates a newline processor that interprets the newlines as a separator. See Newline.asSeparator() for more information. Splits line on any of the given tokens, formats using the first token.

Parameters:

newlines - The newlines.

Returns:

A newline processor that interprets the newlines as a separator.

newlineAsSeparator

public static NewlineProcessor newlineAsSeparator(Newline... newlines)

Creates a newline processor that interprets the newlines as a separator. See Newline.asSeparator() for more information. Splits line on any of the given tokens, formats using the first token.

Parameters:

newlines - The newlines.

Returns:

A newline processor that interprets the newlines as a separator.

newlineAsTerminator

public static NewlineProcessor newlineAsTerminator(Iterable<? extends Newline> newlines)

Creates a newline processor that interprets the newlines as a terminator. See Newline.asTerminator() for more information. Splits line on any of the given tokens, formats using the first token.

Parameters:

newlines - The newlines.

Returns:

A newline processor that interprets the newlines as a terminator.

newlineAsTerminator

public static NewlineProcessor newlineAsTerminator(Newline... newlines)

Creates a newline processor that interprets the newlines as a terminator. See Newline.asTerminator() for more information. Splits line on any of the given tokens, formats using the first token.

Parameters:

newlines - The newlines.

Returns:

A newline processor that interprets the newlines as a terminator.

newlineFiltering

public static NewlineProcessor newlineFiltering(NewlineProcessor processor,
                                                Predicate<? super String> filter)

Creates a newline processor that behaves like the given processor, but filters out lines that do not match the given predicate. When splitting, such lines are omitted from the returned lines. When formatting, such lines are omitted from the formatted output.

Parameters:

processor - The processor to wrap.

filter - The filter to apply.

Returns:

A newline processor that behaves like the given processor, but filters out lines that do not match the

newlineOfToken

public static Newline newlineOfToken(String token)

newlineTokenAsSeparator

public static NewlineProcessor newlineTokenAsSeparator(String... tokens)

Creates a newline processor that interprets the newlines as a separator. See Newline.asSeparator() for more information. Splits line on any of the given tokens, formats using the first token.

Parameters:

tokens - The string tokens that represents the newlines, e.g. "\n" for Unix newlines.

Returns:

A newline processor that interprets the newlines as a separator.

newlineTokenAsSeparator

public static NewlineProcessor newlineTokenAsSeparator(Iterable<String> tokens)

Creates a newline processor that interprets the newlines as a separator. See Newline.asSeparator() for more information. Splits line on any of the given tokens, formats using the first token.

Parameters:

tokens - The string tokens that represents the newlines, e.g. "\n" for Unix newlines.

Returns:

A newline processor that interprets the newlines as a separator.

newlineTokenAsTerminator

public static NewlineProcessor newlineTokenAsTerminator(Iterable<String> tokens)

Creates a newline processor that interprets the newlines as a terminator. See Newline.asTerminator() for more information. Splits line on any of the given tokens, formats using the first token.

Parameters:

tokens - The string tokens that represents the newlines, e.g. "\n" for Unix newlines.

Returns:

A newline processor that interprets the newlines as a terminator.

newlineTokenAsTerminator

public static NewlineProcessor newlineTokenAsTerminator(String... tokens)

Creates a newline processor that interprets the newlines as a terminator. See Newline.asTerminator() for more information. Splits line on any of the given tokens, formats using the first token.

Parameters:

tokens - The string tokens that represents the newlines, e.g. "\n" for Unix newlines.

Returns:

A newline processor that interprets the newlines as a terminator.

transformingWriter

public static Writer transformingWriter(Writer writer,
                                        Newline target,
                                        Newline... source)

Creates a writer with the same content as the given write, but with all source newlines replaced by the given target newline.

Note: for performance, you should not write single characters to the returned writer. If needed, wrap it in a buffered writer or similar.

Parameters:

writer - Writer to wrap.

target - Target newline to convert to.

source - Source newlines to convert to the target newline.

Returns:

A writer that replaces source newlines with the target newline.