Module ushiosan.jvm.utilities

Package ushiosan.jvm

Class UString

java.lang.Object

ushiosan.jvm.UString

public final class UString
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	UString.UGeneratorType

Method Summary

Modifier and Type	Method	Description
static @NotNull @Unmodifiable CharSequence	capitalize(@NotNull CharSequence content, boolean allContent)	Transforms the text string and converts each word start to an uppercase letter
static @NotNull @Unmodifiable CharSequence	capitalizeWord(@NotNull CharSequence content)	Change the first letter of the word to a capital letter.
static @NotNull @Unmodifiable CharSequence	randomSequence(@NotNull Random random, int size, char... ignore)	Generate a pseudo random text string, depending on the selected setting
static @NotNull @Unmodifiable CharSequence	randomSequence(@NotNull Random random, int size, @NotNull UString.UGeneratorType generatorType, char... ignore)	Generate a pseudo random text string, depending on the selected setting

Methods inherited from class java.lang.Object

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

Method Details

capitalize

@NotNull
public static @NotNull @Unmodifiable CharSequence capitalize(@NotNull
 @NotNull CharSequence content,
 boolean allContent)

Transforms the text string and converts each word start to an uppercase letter

Parameters:

content - the content to convert

allContent - option used to convert all words or only the first word of the entire content

Returns:

capitalize content string

capitalizeWord

@NotNull
public static @NotNull @Unmodifiable CharSequence capitalizeWord(@NotNull
 @NotNull CharSequence content)

Change the first letter of the word to a capital letter.

This method cleans the content of spaces and only converts to a word and not a complete content.

Parameters:

content - the content to convert

Returns:

the converted content

randomSequence

@NotNull
public static @NotNull @Unmodifiable CharSequence randomSequence(@NotNull
 @NotNull Random random,
 int size,
 @NotNull
 @NotNull UString.UGeneratorType generatorType,
 char... ignore)

Generate a pseudo random text string, depending on the selected setting

Parameters:

random - an instance of random type to generate the content

size - size of characters that the string will have

generatorType - the type of configuration used

ignore - all the characters you want to ignore within the result

Returns:

a pseudo random text string

See Also:

• UString.UGeneratorType

randomSequence

@NotNull
public static @NotNull @Unmodifiable CharSequence randomSequence(@NotNull
 @NotNull Random random,
 int size,
 char... ignore)

Generate a pseudo random text string, depending on the selected setting

Parameters:

random - an instance of random type to generate the content

size - size of characters that the string will have

ignore - all the characters you want to ignore within the result

Returns:

a pseudo random text string

See Also:

• randomSequence(Random, int, UGeneratorType, char...)
• UString.UGeneratorType