org.omnifaces.util

Class ResourcePaths

java.lang.Object

org.omnifaces.util.ResourcePaths

public final class ResourcePaths
extends Object

Utility class for working with (Servlet) resource paths, providing methods to handle their prefixes, extensions etc.

Since:

1.4

Author:

Arjan Tijms

Method Summary

Modifier and Type	Method and Description
static Set<String>	filterExtension(Set<String> resources) Filters away every resource in the given set that has an extension.
static String	getExtension(String resource) Gets the extension of a resource if any.
static boolean	isDirectory(String resourcePath) Checks if the given resource path obtained from ServletContext.getResourcePaths(String) represents a directory.
static boolean	isExtensionless(String viewId)
static String	stripExtension(String resource) Strips the extension from a resource if any.
static String	stripPrefixPath(String prefix, String resource) Strips the given prefix path from the given resource path if any.
static String	stripTrailingSlash(String resource) Strips the trailing slash(es) from the given resource path if any.

Methods inherited from class java.lang.Object

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

Method Detail

isDirectory

public static boolean isDirectory(String resourcePath)

Checks if the given resource path obtained from ServletContext.getResourcePaths(String) represents a directory.

Parameters:

resourcePath - the resource path to check

Returns:

true if the resource path represents a directory, false otherwise

stripPrefixPath

public static String stripPrefixPath(String prefix,
                                     String resource)

Strips the given prefix path from the given resource path if any.

Parameters:

prefix - The prefix to be stripped.

resource - The resource to strip the prefix from.

Returns:

the resource without the prefix path, or as-is if it didn't start with this prefix.

stripTrailingSlash

public static String stripTrailingSlash(String resource)

Strips the trailing slash(es) from the given resource path if any.

Parameters:

resource - The resource to strip the trailing slash from.

Returns:

the resource without the trailing slash, or as-is if it didn't have a trailing slash.

Since:

2.6

stripExtension

public static String stripExtension(String resource)

Strips the extension from a resource if any. This extension is defined as everything after the last occurrence of a period, including the period itself. E.g. input "index.xhtml" will return "index".

Parameters:

resource - The resource to strip the extension from.

Returns:

the resource without its extension, of as-is if it doesn't have an extension.

getExtension

public static String getExtension(String resource)

Gets the extension of a resource if any. This extension is defined as everything after the last occurrence of a period, including the period itself. E.g. input "index.xhtml" will return ".xhtml'.

Parameters:

resource - The resource to get the extension from.

Returns:

the extension of the resource, or null if it doesn't have an extension.

isExtensionless

public static boolean isExtensionless(String viewId)

filterExtension

public static Set<String> filterExtension(Set<String> resources)

Filters away every resource in the given set that has an extension.

Parameters:

resources - A set of resources to be filtered

Returns:

A set where no resource has an extension. May be empty, but never null.