org.ujorm.tools.common

Class StringUtils

java.lang.Object

org.ujorm.tools.common.StringUtils

public class StringUtils
extends Object

Methods to reading an text resource to the String.

Usage

 try (Stream<String> stream = StringUtils.readLines(StringUtils.class,  "text", "dummy.txt")) {
     String[] result = stream.toArray(String[]::new);
     assertEquals("abc", result[0]);
 }
 

Author:

Pavel Ponec

Field Summary

Fields

Modifier and Type	Field and Description
static String	SEPARATOR File separator (one character is required)

Constructor Summary

Constructors

Constructor and Description
StringUtils() With a charset UTF-8
StringUtils(@NotNull Charset charset)
StringUtils(@NotNull Charset charset, @NotNull Class<?> classOfLoader)

Method Summary

Modifier and Type	Method and Description
protected String	buildResource(@Nullable Class<?> basePackage, String... resourcePath) Build a resource
static @NotNull String	read(@NotNull Class<?> basePackage, String... resourcePath) Read a content of the resource encoded by UTF-8.
static @NotNull String	read(@NotNull InputStream is) Read a content of the resource encoded by UTF-8.
@NotNull String	readBody(@NotNull Class<?> basePackage, String... resourcePath) Read a content of the resource encoded by UTF-8.
@NotNull String	readBody(@NotNull InputStream is) Read a content of the resource encoded by UTF-8.
@NotNull String	readBody(String... resource) Read a content of the resource encoded by UTF-8.
static @NotNull Stream<String>	readLines(@Nullable Class<?> basePackage, String... resourcePath) Read a content of the resource encoded by UTF-8.
static @NotNull Stream<String>	readLines(String... resourcePath) Read a content of the resource encoded by UTF-8.
static @NotNull Stream<String>	readLines(@NotNull URL url) Read a closeable line stream of the URL.
@NotNull Stream<String>	readRows(@Nullable Class<?> basePackage, String... resourcePath) Read a content of the resource encoded by UTF-8.
@NotNull Stream<String>	readRows(@NotNull InputStream is) Read a closeable line stream of the URL.
@NotNull Stream<String>	readRows(@NotNull URL url) Read a closeable line stream of the URL.

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR

public static final String SEPARATOR

File separator (one character is required)

See Also:

Constant Field Values

Constructor Detail

StringUtils

public StringUtils()

With a charset UTF-8

StringUtils

public StringUtils(@NotNull
                   @NotNull Charset charset)

StringUtils

public StringUtils(@NotNull
                   @NotNull Charset charset,
                   @NotNull
                   @NotNull Class<?> classOfLoader)

Method Detail

readBody

@NotNull
public @NotNull String readBody(@NotNull
                                         String... resource)

Read a content of the resource encoded by UTF-8. A line separator can be modifed in the result.

readBody

@NotNull
public @NotNull String readBody(@NotNull
                                         @NotNull Class<?> basePackage,
                                         @NotNull
                                         String... resourcePath)

Read a content of the resource encoded by UTF-8. A line separator can be modifed in the result.

readBody

@NotNull
public @NotNull String readBody(@NotNull
                                         @NotNull InputStream is)

Read a content of the resource encoded by UTF-8. A line separator can be modifed in the result.

readRows

@NotNull
public @NotNull Stream<String> readRows(@Nullable
                                                 @Nullable Class<?> basePackage,
                                                 @NotNull
                                                 String... resourcePath)

Read a content of the resource encoded by UTF-8. A line separator can be modifed in the result.

Returns:

The result must be closed.

readRows

@NotNull
public @NotNull Stream<String> readRows(@NotNull
                                                 @NotNull URL url)
                                          throws IOException

Read a closeable line stream of the URL. A line separator can be modifed in the result.

Returns:

The result must be closed.

Throws:

IOException

readRows

@NotNull
public @NotNull Stream<String> readRows(@NotNull
                                                 @NotNull InputStream is)
                                          throws IOException

Read a closeable line stream of the URL. A line separator can be modifed in the result

Returns:

The result must be closed.

Throws:

IOException

buildResource

protected String buildResource(@Nullable
                               @Nullable Class<?> basePackage,
                               @NotNull
                               String... resourcePath)

Build a resource

read

@NotNull
public static @NotNull String read(@NotNull
                                            @NotNull Class<?> basePackage,
                                            @NotNull
                                            String... resourcePath)

Read a content of the resource encoded by UTF-8. A line separator can be modifed in the result.

read

@NotNull
public static @NotNull String read(@NotNull
                                            @NotNull InputStream is)

Read a content of the resource encoded by UTF-8. A line separator can be modifed in the result.

readLines

@NotNull
public static @NotNull Stream<String> readLines(@NotNull
                                                         @NotNull URL url)
                                                  throws IOException

Read a closeable line stream of the URL. A line separator can be modifed in the result.

Returns:

The result must be closed.

Throws:

IOException

readLines

@NotNull
public static @NotNull Stream<String> readLines(@Nullable
                                                         @Nullable Class<?> basePackage,
                                                         @NotNull
                                                         String... resourcePath)

Read a content of the resource encoded by UTF-8. A line separator can be modifed in the result.

Returns:

The result must be closed.

readLines

@NotNull
public static @NotNull Stream<String> readLines(@NotNull
                                                         String... resourcePath)

Read a content of the resource encoded by UTF-8. A line separator can be modifed in the result.

Returns:

The result must be closed.