net.gdface.utils

Class ClassResourceUtils

java.lang.Object

net.gdface.utils.ClassResourceUtils

public class ClassResourceUtils
extends java.lang.Object

classpath resource 工具

Author:

guyadong

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ClassResourceUtils.FileFilter 文件名过滤器接口

Constructor Summary

Constructors

Constructor and Description
ClassResourceUtils()

Method Summary

Modifier and Type	Method and Description
static java.util.List<java.lang.String>	getFilesUnchecked(java.lang.Class<?> clazz, java.lang.String path, ClassResourceUtils.FileFilter filter)
static java.util.List<java.lang.String>	getFilesUnchedked(java.lang.Class<?> clazz, java.lang.String path) 参见 getResourceFileList(Class, String), IOException封装为RuntimeException,
static java.net.URL	getResource(java.lang.Class<?> claz, java.lang.String path) Finds a resource with the given name.
static java.io.InputStream	getResourceAsStream(java.lang.Class<?> clazz, java.lang.String name) Returns an input stream for reading the specified resource.
static java.util.List<java.lang.String>	getResourceFileList(java.lang.Class<?> clazz, java.lang.String dirPath) List file names for a resource folder.
static java.lang.String	normalizeDirPath(java.lang.String path) Return a normalized directory path, end with "/", but not start with one
static java.lang.String	normalizePath(java.lang.String path) Return a context-relative path, beginning with a "/", that represents the canonical version of the specified path after ".." and "." elements are resolved out.
static boolean	resourceExist(java.lang.Class<?> clazz, java.lang.String resource) Returns true if resource exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassResourceUtils

public ClassResourceUtils()

Method Detail

getFilesUnchedked

public static java.util.List<java.lang.String> getFilesUnchedked(java.lang.Class<?> clazz,
                                                                 java.lang.String path)

参见 getResourceFileList(Class, String),
IOException封装为RuntimeException,

Parameters:

clazz - Class to use when getting the System classloader

path -

Returns:

getFilesUnchecked

public static java.util.List<java.lang.String> getFilesUnchecked(java.lang.Class<?> clazz,
                                                                 java.lang.String path,
                                                                 ClassResourceUtils.FileFilter filter)

Parameters:

clazz - Class to use when getting the System classloader

path -

filter - A filename filter

Returns:

See Also:

getFilesUnchedked(Class, String)

resourceExist

public static boolean resourceExist(java.lang.Class<?> clazz,
                                    java.lang.String resource)

Returns true if resource exist.

Parameters:

clazz - Class to use when getting the System classloader

resource -

Returns:

normalizePath

public static java.lang.String normalizePath(java.lang.String path)

Return a context-relative path, beginning with a "/", that represents the canonical version of the specified path after ".." and "." elements are resolved out. If the specified path attempts to go outside the boundaries of the current context (i.e. too many ".." path elements are present), return null instead.

Parameters:

path - Path to be normalized

Returns:

String normalized path

normalizeDirPath

public static java.lang.String normalizeDirPath(java.lang.String path)

Return a normalized directory path, end with "/", but not start with one

Parameters:

path - Path to be normalized

Returns:

Path to be normalized

See Also:

normalizePath(String)

getResourceAsStream

public static java.io.InputStream getResourceAsStream(java.lang.Class<?> clazz,
                                                      java.lang.String name)

Returns an input stream for reading the specified resource.

Parameters:

clazz - Class to use when getting the System classloader (used if no Thread Context classloader available or fails to get resource).

name - name of the resource

Returns:

InputStream for the resource.

See Also:

getResource(Class, String)

getResource

public static java.net.URL getResource(java.lang.Class<?> claz,
                                       java.lang.String path)

Finds a resource with the given name. Checks the Thread Context classloader, then uses the System classloader. Should replace all calls to Class.getResourceAsString when the resource might come from a different classloader. (e.g. a webapp).

Parameters:

claz - Class to use when getting the System classloader (used if no Thread Context classloader available or fails to get resource).

path - name of the resource

Returns:

A URL object for reading the resource, or null if the resource could not be found or the invoker doesn't have adequate privileges to get the resource.

getResourceFileList

public static java.util.List<java.lang.String> getResourceFileList(java.lang.Class<?> clazz,
                                                                   java.lang.String dirPath)
                                                            throws java.io.IOException

List file names for a resource folder. Not recursive. This is basically a brute-force implementation. Works for regular files and also JARs.
refer to: Java: Listing the contents of a resource directory

Parameters:

clazz - Any java class that lives in the same place as the resources you want.

dirPath -

Returns:

Just the name of each member item, not the full paths.

Throws:

java.io.IOException