Module com.github.robtimus.junit.support

Package com.github.robtimus.junit.support.extension.testresource

Class TestResourceLoaders

java.lang.Object

com.github.robtimus.junit.support.extension.testresource.TestResourceLoaders

public final class TestResourceLoaders
extends Object

TestResourceLoaders contains some utility methods that can be used with LoadWith to load resource into objects.

Author:

Rob Spoor

Since:

2.0

Method Summary

Modifier and Type	Method	Description
static byte[]	toBytes(InputStream inputStream)	Loads a resource into a byte array.
static CharSequence	toCharSequence(Reader reader)	Loads a resource into a CharSequence.
static CharSequence	toCharSequence(Reader reader, String lineSeparator)	Loads a resource into a CharSequence.
static List<String>	toLines(Reader reader)	Loads a resource into a list, where each element represents a line from the resource.
static String[]	toLinesArray(Reader reader)	Loads a resource into an array, where each element represents a line from the resource.
static Properties	toProperties(Reader reader)	Loads a resource into a Properties object.
static String	toString(Reader reader)	Loads a resource into a string.
static String	toString(Reader reader, String lineSeparator)	Loads a resource into a string.
static StringBuilder	toStringBuilder(Reader reader)	Loads a resource into a StringBuilder.
static StringBuilder	toStringBuilder(Reader reader, String lineSeparator)	Loads a resource into a StringBuilder.

Methods inherited from class java.lang.Object

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

Method Detail

toString

public static String toString(Reader reader)
                       throws IOException

Loads a resource into a string.

Parameters:

reader - A Reader containing the contents of the resource.

Returns:

The content of the resource as a string.

Throws:

NullPointerException - If the given reader is null.

IOException - If an error occurred when loading the resource.

toString

public static String toString(Reader reader,
                              String lineSeparator)
                       throws IOException

Loads a resource into a string. Any existing line separator will be replaced by the given line separator.

Parameters:

reader - A Reader containing the contents of the resource.

lineSeparator - The line separator to use.

Returns:

The content of the resource as a string.

Throws:

NullPointerException - If the given reader or line separator is null.

IOException - If an error occurred when loading the resource.

toStringBuilder

public static StringBuilder toStringBuilder(Reader reader)
                                     throws IOException

Loads a resource into a StringBuilder.

Parameters:

reader - A Reader containing the contents of the resource.

Returns:

A StringBuilder containing the contents of the resource.

Throws:

NullPointerException - If the given reader is null.

IOException - If an error occurred when loading the resource.

toStringBuilder

public static StringBuilder toStringBuilder(Reader reader,
                                            String lineSeparator)
                                     throws IOException

Loads a resource into a StringBuilder. Any existing line separator will be replaced by the given line separator.

Parameters:

reader - A Reader containing the contents of the resource.

lineSeparator - The line separator to use.

Returns:

A StringBuilder containing the contents of the resource.

Throws:

NullPointerException - If the given reader or line separator is null.

IOException - If an error occurred when loading the resource.

toCharSequence

public static CharSequence toCharSequence(Reader reader)
                                   throws IOException

Loads a resource into a CharSequence.

Parameters:

reader - A Reader containing the contents of the resource.

Returns:

The content of the resource as a CharSequence.

Throws:

NullPointerException - If the given reader is null.

IOException - If an error occurred when loading the resource.

toCharSequence

public static CharSequence toCharSequence(Reader reader,
                                          String lineSeparator)
                                   throws IOException

Loads a resource into a CharSequence. Any existing line separator will be replaced by the given line separator.

Parameters:

reader - A Reader containing the contents of the resource.

lineSeparator - The line separator to use.

Returns:

The content of the resource as a CharSequence.

Throws:

NullPointerException - If the given reader or line separator is null.

IOException - If an error occurred when loading the resource.

toBytes

public static byte[] toBytes(InputStream inputStream)
                      throws IOException

Loads a resource into a byte array.

Parameters:

inputStream - An InputStream containing the contents of the resource.

Returns:

The content of the resource as a byte array.

Throws:

NullPointerException - If the given input stream is null.

IOException - If an error occurred when loading the resource.

toLines

public static List<String> toLines(Reader reader)
                            throws IOException

Loads a resource into a list, where each element represents a line from the resource.

Parameters:

reader - A Reader containing the contents of the resource.

Returns:

A list containing the lines of the resources/

Throws:

NullPointerException - If the given reader is null.

IOException - If an error occurred when loading the resource.

Since:

2.2

toLinesArray

public static String[] toLinesArray(Reader reader)
                             throws IOException

Loads a resource into an array, where each element represents a line from the resource.

Parameters:

reader - A Reader containing the contents of the resource.

Returns:

An array containing the lines of the resources/

Throws:

NullPointerException - If the given reader is null.

IOException - If an error occurred when loading the resource.

Since:

2.2

toProperties

public static Properties toProperties(Reader reader)
                               throws IOException

Loads a resource into a Properties object.

Parameters:

reader - A Reader containing the contents of the resource.

Returns:

A Properties object containing the properties from the resource.

Throws:

NullPointerException - If the given reader is null.

IOException - If an error occurred when loading the resource.

See Also:

Properties.load(Reader)