org.kitteh.irc.client.library.util

Class StringUtil

java.lang.Object

org.kitteh.irc.client.library.util.StringUtil

public final class StringUtil
extends Object

String tools!

Method Summary

Modifier and Type	Method and Description
static @NonNull String	combineSplit(@NonNull String[] split, int start) Combines an array into a space-delimited string from a starting index.
static @NonNull String	combineSplit(@NonNull String[] split, int start, int length, @NonNull String delimiter) Combines an array into a super string!
static @NonNull String	filterPassword(@NonNull String password) Converts all characters of a password to asterisks.
static @NonNull String	makeRainbow(@NonNull String message) Turns a message into a rainbow.
static @NonNull String	makeRainbow(@NonNull String message, @NonNull Format[] colorOrder) Turns a message into a rainbow.
static @NonNull String	toLowerCase(@NonNull ClientLinked linked, @NonNull String input) Converts a given String to lowercase per spec.
static @NonNull String	toLowerCase(@NonNull Client client, @NonNull String input) Converts a given String to lowercase per spec.

Methods inherited from class java.lang.Object

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

Method Detail

combineSplit

public static @NonNull String combineSplit(@NonNull String[] split,
                                           int start,
                                           int length,
                                           @NonNull String delimiter)

Combines an array into a super string!

Invalid index or length, or a length too long for the array, will be ignored.

Parameters:

split - the split array

start - index at which to start

length - how many elements to include

delimiter - delimiter

Returns:

the combined string

Throws:

IllegalArgumentException - for a null array, a length less than 1, an index less than 0, or a null delimiter

combineSplit

public static @NonNull String combineSplit(@NonNull String[] split,
                                           int start)

Combines an array into a space-delimited string from a starting index.

Invalid starting index will result

Parameters:

split - the split array

start - index at which to start

Returns:

the combined string

Throws:

IllegalArgumentException - for null array or index less than 0

makeRainbow

public static @NonNull String makeRainbow(@NonNull String message)

Turns a message into a rainbow.

Parameters:

message - message to become rainbow

Returns:

the colorful new message

Throws:

IllegalArgumentException - for null message

makeRainbow

public static @NonNull String makeRainbow(@NonNull String message,
                                          @NonNull Format[] colorOrder)

Turns a message into a rainbow.

Parameters:

message - message to become rainbow

colorOrder - order of colors to send

Returns:

the colorful new message

Throws:

IllegalArgumentException - for null parameters, null entries in array, or non-color entries in array

toLowerCase

public static @NonNull String toLowerCase(@NonNull ClientLinked linked,
                                          @NonNull String input)

Converts a given String to lowercase per spec.

Parameters:

linked - the client provider

input - string to be lowercased

Returns:

lowercased string

Throws:

IllegalArgumentException - if client provider is null

IllegalArgumentException - if input is null

See Also:

CaseMapping.toLowerCase(java.lang.String)

toLowerCase

public static @NonNull String toLowerCase(@NonNull Client client,
                                          @NonNull String input)

Converts a given String to lowercase per spec.

Parameters:

client - the client

input - string to be lowercased

Returns:

lowercased string

Throws:

IllegalArgumentException - if client is null

IllegalArgumentException - if input is null

See Also:

CaseMapping.toLowerCase(java.lang.String)

filterPassword

public static @NonNull String filterPassword(@NonNull String password)

Converts all characters of a password to asterisks.

Parameters:

password - password

Returns:

filtered password