net.ninjacat.smooth.utils

Class Joiner

java.lang.Object

net.ninjacat.smooth.utils.Joiner

public class Joiner
extends Object

Object that joins parts of text specified as iterable, varargs or array.

If neither skipNulls() nor useForNull(String) is specified, the joining methods will throw IllegalArgumentException if any given element is null.

Field Summary

Fields

Modifier and Type	Field and Description
static Joiner	PATH_JOINER Ready to use Joiner for paths

Method Summary

Modifier and Type	Method and Description
<A extends Appendable> void	appendIterableTo(A appendable, Iterable<?> parts) Appends parts of Iterable to a given Appendable
<A extends Appendable> void	appendTo(A appendable, Object... parts) Appends parts to a given Appendable.
String	join(Object... parts) Joins parts and returns them as a string.
String	joinIterable(Iterable<?> parts) Joins parts and returns them as a string.
Joiner	noDuplicateSeparators() Configures Joiner to prevent duplicate separators.
static Joiner	on(String separator) Creates a new Joiner object with a specified separator.
Joiner	skipNulls() Configures Joiner to ignore null elements.
Joiner	useForNulls(String forNulls) Sets the string to use in place of null elements.

Methods inherited from class java.lang.Object

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

Field Detail

PATH_JOINER

public static final Joiner PATH_JOINER

Ready to use Joiner for paths

Method Detail

on

public static Joiner on(String separator)

Creates a new Joiner object with a specified separator. New Joiner will fail on null values in input and will put separators even if they are already present

Parameters:

separator - Separator to use for text concatenation.

Returns:

new Joiner object.

useForNulls

public Joiner useForNulls(String forNulls)

Sets the string to use in place of null elements. If Joiner is set to skip nulls this method does nothing.

Parameters:

forNulls - String to substitute nulls with.

Returns:

Updated Joiner

skipNulls

public Joiner skipNulls()

Configures Joiner to ignore null elements. If useForNulls(String) has been configured, it will be ignored from now on.

Returns:

Updated Joiner

noDuplicateSeparators

public Joiner noDuplicateSeparators()

Configures Joiner to prevent duplicate separators. This is useful when constructing file system paths.

For example

Joiner.on("/").join("/", "somepath", "otherpath/", "/filename");

will return "//somepath/otherpath///filename" and

Joiner.on("/").noDuplicateSeparators().join("/", "somepath", "otherpath/", "/filename");

will return "/somepath/otherpath/filename"

Returns:

Updated Joiner

join

public String join(Object... parts)

Joins parts and returns them as a string. Object.toString() is called on each part before joining.

Parameters:

parts - Parts of string to be joined.

Returns:

Joined string

Throws:

IllegalArgumentException - if parts contain null and neither skipNulls() nor useForNulls(String) are used.

joinIterable

public String joinIterable(Iterable<?> parts)

Joins parts and returns them as a string. Object.toString() is called on each part before joining.

Parameters:

parts - Parts of string to be joined.

Returns:

Joined string

Throws:

IllegalArgumentException - if parts contain null and neither skipNulls() nor useForNulls(String) are used.

appendTo

public <A extends Appendable> void appendTo(A appendable,
                                            Object... parts)
                                     throws IOException

Appends parts to a given Appendable. Object.toString() is called on each part before joining.

Type Parameters:

A - Type of Appendable

Parameters:

appendable - Appendable to append parts to

parts - Parts to be joined

Throws:

IOException - Thrown by Appendable

IllegalArgumentException - if parts contain null and neither skipNulls() nor useForNulls(String) are used.

appendIterableTo

public <A extends Appendable> void appendIterableTo(A appendable,
                                                    Iterable<?> parts)
                                             throws IOException

Appends parts of Iterable to a given Appendable

Type Parameters:

A - Type of Appendable

Parameters:

appendable - Appendable to append parts to

parts - Iterable of parts

Throws:

IOException - Thrown by Appendable

IllegalArgumentException - if parts contain null and neither skipNulls() nor useForNulls(String) are used.