Package org.assertstruct

Class Res

java.lang.Object

org.assertstruct.Res

public class Res
extends Object

Class provide comfortable way to work with text data from classpath or strings. If content is in JSON5 format it can be parsed and provided as Template or converted to POJO class. Res class track location of the resource and provide convenient way to load it and transform into other formats.

Method Summary

Modifier and Type	Method	Description
<T> T	as(Class<T> type)	Provides the content of the resource in JSON5 format converted to provided class.
char[]	asChars()	Provides the content of the resource as a char array.
String	asString()	Provides the content of the resource as a string.
Template	asTemplate()	Provides the content of the resource as a template.
static Res	from(String resPath)	Creates a new Res object from the given resource path.
static Res	of(String content)	Creates a new Res object with the given content.
static Res	res(@NonNull String res)	Create resource by autodetect type of resource
static Res	res(@NonNull String res, StackTraceElement traceElement, AssertStructService env)

Methods inherited from class java.lang.Object

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

Method Details

res

public static Res res(@NonNull
 @NonNull String res)

Create resource by autodetect type of resource

Parameters:

res - the path to the resource or resource content

Returns:

resource

from

public static Res from(String resPath)

Creates a new Res object from the given resource path. The path can be absolute or relative to the class executed from method Resource existence will be checked during creating, however loading will be delayed until accessed.

Parameters:

resPath - the path to the resource.

Returns:

a new Res object representing the resource.

Throws:

IllegalArgumentException - if the resource cannot be found

of

public static Res of(String content)

Creates a new Res object with the given content.

Parameters:

content - the content for the Res object

Returns:

a new Res object with the specified content

res

public static Res res(@NonNull
 @NonNull String res,
 StackTraceElement traceElement,
 AssertStructService env)

asString

public String asString()

Provides the content of the resource as a string.

Returns:

the content

asChars

public char[] asChars()

Provides the content of the resource as a char array.

Returns:

the content

asTemplate

public Template asTemplate()

Provides the content of the resource as a template. Template is parsed on the first call and then cached.

Returns:

the template

as

public <T> T as(Class<T> type)

Provides the content of the resource in JSON5 format converted to provided class.

Parameters:

type - required class

Returns:

converted content This method will work only if the resource is in JSON5 format and default JSonConverter support this conversion