org.kocakosm.pitaya.util

Class Joiner

java.lang.Object

org.kocakosm.pitaya.util.Joiner

public final class Joiner
extends Object

Joins multiple Strings into a single one. Instances of this class are immutable.

Author:

Osman KOCAK

See Also:

Splitter

Method Summary

Methods

Modifier and Type	Method and Description
Joiner	ignoreEmptyStrings() Returns a new Joiner that will behave as this one except that it will ignore empty input Strings.
Joiner	ignoreNulls() Returns a new Joiner that will behave as this one except that it will ignore null input values.
String	join(Iterable<?> parts) Joins the given Strings according to its configuration.
String	join(Object... parts) Joins the given Strings according to its configuration.
static Joiner	on(String separator) Returns a new Joiner that will use the specified separator, no prefix, no suffix and "null" for null values.
Joiner	replaceEmptyStringWith(String forEmpty) Returns a new Joiner that will behave as this one except that it will replace empty input Strings with the specified value.
Joiner	replaceNullWith(String forNull) Returns a new Joiner that will behave as this one except that it will replace null input values with the specified String.
Joiner	trimInputs() Returns a new Joiner that will behave as this one except that it will trim inputs before joining them.
Joiner	withPrefix(String prefix) Returns a new Joiner that will behave as this one except that it will use the specified prefix when joining Strings.
Joiner	withSuffix(String suffix) Returns a new Joiner that will behave as this one except that it will use the specified suffix when joining Strings.

Methods inherited from class java.lang.Object

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

Method Detail

on

public static Joiner on(String separator)

Returns a new Joiner that will use the specified separator, no prefix, no suffix and "null" for null values.

Parameters:

separator - the separator.

Returns:

the created Joiner.

Throws:

NullPointerException - if separator is null.

trimInputs

public Joiner trimInputs()

Returns a new Joiner that will behave as this one except that it will trim inputs before joining them.

Returns:

a new Joiner with the desired configuration.

ignoreNulls

public Joiner ignoreNulls()

Returns a new Joiner that will behave as this one except that it will ignore null input values.

Returns:

a new Joiner with the desired configuration.

ignoreEmptyStrings

public Joiner ignoreEmptyStrings()

Returns a new Joiner that will behave as this one except that it will ignore empty input Strings.

Returns:

a new Joiner with the desired configuration.

replaceNullWith

public Joiner replaceNullWith(String forNull)

Returns a new Joiner that will behave as this one except that it will replace null input values with the specified String.

Parameters:

forNull - the String to use for nulls.

Returns:

a new Joiner with the desired configuration.

Throws:

NullPointerException - if forNull is null.

replaceEmptyStringWith

public Joiner replaceEmptyStringWith(String forEmpty)

Returns a new Joiner that will behave as this one except that it will replace empty input Strings with the specified value.

Parameters:

forEmpty - the value to use for empty Strings.

Returns:

a new Joiner with the desired configuration.

Throws:

NullPointerException - if forEmpty is null.

withPrefix

public Joiner withPrefix(String prefix)

Returns a new Joiner that will behave as this one except that it will use the specified prefix when joining Strings.

Parameters:

prefix - the prefix.

Returns:

a new Joiner with the desired configuration.

Throws:

NullPointerException - if prefix is null.

withSuffix

public Joiner withSuffix(String suffix)

Returns a new Joiner that will behave as this one except that it will use the specified suffix when joining Strings.

Parameters:

suffix - the suffix.

Returns:

a new Joiner with the desired configuration.

Throws:

NullPointerException - if suffix is null.

join

public String join(Object... parts)

Joins the given Strings according to its configuration.

Parameters:

parts - the parts to join.

Returns:

the created String.

Throws:

NullPointerException - if parts is null.

join

public String join(Iterable<?> parts)

Joins the given Strings according to its configuration.

Parameters:

parts - the parts to join.

Returns:

the created String.

Throws:

NullPointerException - if parts is null.