ru.vyarus.guicey.gsp.app.util

Class ResourceLookup

java.lang.Object

ru.vyarus.guicey.gsp.app.util.ResourceLookup

public final class ResourceLookup
extends java.lang.Object

Utility used to lookup static resources in multiple locations. This is used for applications extensions mechanism when additional resources could be mapped into application from different classpath location.

Since:

04.12.2018

Method Summary

Modifier and Type	Method and Description
static boolean	exists(java.lang.String path) Checks if absolute resource path exists in the classpath.
static void	existsOrFail(java.lang.String path) Shortcut for exists(String) with fail in case of not found template.
static java.lang.String	lookup(java.lang.Class base, java.lang.String path) Lookup path relative to class.
static java.lang.String	lookup(java.lang.String path, java.util.List<java.lang.String> rootPaths) Searches provided resource in multiple classpath locations.
static java.lang.String	lookupOrFail(java.lang.String path, java.util.List<java.lang.String> rootPaths) Shortcut for lookup(String, List) with fail in case of not found template.

Methods inherited from class java.lang.Object

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

Method Detail

lookup

public static java.lang.String lookup(java.lang.Class base,
                                      java.lang.String path)

Lookup path relative to class.

Parameters:

base - class to search path relative to

path - relative path

Returns:

found full path or null

lookup

public static java.lang.String lookup(java.lang.String path,
                                      java.util.List<java.lang.String> rootPaths)

Searches provided resource in multiple classpath locations.

Parameters:

path - static resource path

rootPaths - classpath folders to search resource in

Returns:

resource location path (first occurrence) or null if not found

lookupOrFail

public static java.lang.String lookupOrFail(java.lang.String path,
                                            java.util.List<java.lang.String> rootPaths)
                                     throws TemplateNotFoundException

Shortcut for lookup(String, List) with fail in case of not found template.

Parameters:

path - static resource path

rootPaths - classpath folders to search resource in

Returns:

resource location path (first occurrence)

Throws:

TemplateNotFoundException - if template not found

exists

public static boolean exists(java.lang.String path)

Checks if absolute resource path exists in the classpath.

Parameters:

path - absolute path to check (assumed as absolute event if not starts with /)

Returns:

true if resource exists, false otherwise

existsOrFail

public static void existsOrFail(java.lang.String path)
                         throws TemplateNotFoundException

Shortcut for exists(String) with fail in case of not found template.

Parameters:

path - absolute path to check (assumed as absolute event if not starts with /)

Throws:

TemplateNotFoundException - if template not found