org.kocakosm.pitaya.util

Class Splitter

java.lang.Object

org.kocakosm.pitaya.util.Splitter

public final class Splitter
extends Object

Splits Strings using a predefined separator. Instances of this class are immutable.

Author:

Osman KOCAK

See Also:

Joiner

Method Summary

Methods

Modifier and Type	Method and Description
Splitter	ignoreEmptyStrings() Returns a new Splitter that will behave as this one except that it will ignore empty results.
Splitter	ignorePrefix(String prefix) Returns a new Splitter that will behave as this one except that it will ignore the given prefix.
Splitter	ignoreSuffix(String suffix) Returns a new Splitter that will behave as this one except that it will ignore the given suffix.
Splitter	limit(int limit) Returns a new Splitter that will behave as this one except that it will limit the number of times the splitting pattern is applied.
static Splitter	on(Pattern pattern) Returns a new Splitter that will use the specified pattern to split Strings.
static Splitter	on(String separator) Returns a new Splitter that will use the specified separator to split Strings.
Splitter	replaceEmptyStringWith(String forEmpty) Returns a new Splitter that will behave as this one except that it will replace empty results by the specified String.
List<String>	split(String s) Splits the given String into parts according to its configuration.
Splitter	trimResults() Returns a new Splitter that will behave as this one except that it will trim splitting results.

Methods inherited from class java.lang.Object

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

Method Detail

on

public static Splitter on(String separator)

Returns a new Splitter that will use the specified separator to split Strings.

Parameters:

separator - the separator.

Returns:

the created Splitter.

Throws:

NullPointerException - if separator is null.

on

public static Splitter on(Pattern pattern)

Returns a new Splitter that will use the specified pattern to split Strings.

Parameters:

pattern - the separator pattern.

Returns:

the created Splitter.

Throws:

NullPointerException - if pattern is null.

limit

public Splitter limit(int limit)

Returns a new Splitter that will behave as this one except that it will limit the number of times the splitting pattern is applied. If limit is strictly positive, then the pattern will be applied at most limit - 1 times. If limit is non-positive then the splitting pattern will be applied as many times as possible.

Parameters:

limit - the splitting limit.

Returns:

a new Splitter with the desired configuration.

trimResults

public Splitter trimResults()

Returns a new Splitter that will behave as this one except that it will trim splitting results.

Returns:

a new Splitter with the desired configuration.

ignorePrefix

public Splitter ignorePrefix(String prefix)

Returns a new Splitter that will behave as this one except that it will ignore the given prefix.

Parameters:

prefix - the prefix to ignore.

Returns:

a new Splitter with the desired configuration.

Throws:

NullPointerException - if prefix is null.

ignoreSuffix

public Splitter ignoreSuffix(String suffix)

Returns a new Splitter that will behave as this one except that it will ignore the given suffix.

Parameters:

suffix - the suffix to ignore.

Returns:

a new Splitter with the desired configuration.

Throws:

NullPointerException - if suffix is null.

ignoreEmptyStrings

public Splitter ignoreEmptyStrings()

Returns a new Splitter that will behave as this one except that it will ignore empty results.

Returns:

a new Splitter with the desired configuration.

replaceEmptyStringWith

public Splitter replaceEmptyStringWith(String forEmpty)

Returns a new Splitter that will behave as this one except that it will replace empty results by the specified String.

Parameters:

forEmpty - the value to use for empty Strings.

Returns:

a new Splitter with the desired configuration.

split

public List<String> split(String s)

Splits the given String into parts according to its configuration.

Parameters:

s - the String to split.

Returns:

the parts, as an unmodifiable List.

Throws:

NullPointerException - if s is null.