com.netflix.nicobar.core.utils

Class ClassPathUtils

java.lang.Object

com.netflix.nicobar.core.utils.ClassPathUtils

public class ClassPathUtils
extends java.lang.Object

Utility methods for dealing with classes and resources in a ClassLoader

Constructor Summary

Constructors

Constructor and Description
ClassPathUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	classNameToResourceName(java.lang.String className) Get the resource name for the class file for the given class name
static java.lang.String	classToResourceName(java.lang.Class<?> clazz) Get the resource name for the class file for the given class
static java.nio.file.Path	findRootPathForClass(java.lang.Class<?> clazz) Find the root path for the given class.
static java.nio.file.Path	findRootPathForResource(java.lang.String resourceName, java.lang.ClassLoader classLoader) Find the root path for the given resource.
static java.util.Set<java.nio.file.Path>	getDirectoriesFromJar(java.nio.file.Path pathToJarFile) Get all of the directory paths in a zip/jar file
static java.nio.file.Path	getJarPathFromUrl(java.net.URL jarUrl) Find the jar containing the given resource.
static java.util.Set<java.lang.String>	getJdkPaths() Get a list of JDK packages in the classpath, by scanning the bootstrap classpath.
static java.util.Set<java.lang.String>	scanClassPath(java.lang.String classPath, java.util.Set<java.lang.String> excludeJarSet) Scan the classpath string provided, and collect a set of package paths found in jars and classes on the path.
static java.util.Set<java.lang.String>	scanClassPath(java.lang.String classPath, java.util.Set<java.lang.String> excludeJarSet, java.util.Set<java.lang.String> excludePrefixes, java.util.Set<java.lang.String> includePrefixes) Scan the classpath string provided, and collect a set of package paths found in jars and classes on the path.
static java.util.Set<java.lang.String>	scanClassPathWithExcludes(java.lang.String classPath, java.util.Set<java.lang.String> excludeJarSet, java.util.Set<java.lang.String> excludePrefixes) Scan the classpath string provided, and collect a set of package paths found in jars and classes on the path, excluding any that match a set of exclude prefixes.
static java.util.Set<java.lang.String>	scanClassPathWithIncludes(java.lang.String classPath, java.util.Set<java.lang.String> excludeJarSet, java.util.Set<java.lang.String> includePrefixes) Scan the classpath string provided, and collect a set of package paths found in jars and classes on the path, including only those that match a set of include prefixes.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassPathUtils

public ClassPathUtils()

Method Detail

getJdkPaths

public static java.util.Set<java.lang.String> getJdkPaths()

Get a list of JDK packages in the classpath, by scanning the bootstrap classpath.

Returns:

a set of package path strings (package paths separated by '/' and not '.').

findRootPathForResource

@Nullable
public static java.nio.file.Path findRootPathForResource(java.lang.String resourceName,
                                                  java.lang.ClassLoader classLoader)

Find the root path for the given resource. If the resource is found in a Jar file, then the result will be an absolute path to the jar file. If the resource is found in a directory, then the result will be the parent path of the given resource. For example, if the resourceName is given as "scripts/myscript.groovy", and the path to the file is "/root/sub1/script/myscript.groovy", then this method will return "/root/sub1"

Parameters:

resourceName - relative path of the resource to search for. E.G. "scripts/myscript.groovy"

classLoader - the ClassLoader to search

Returns:

absolute path of the root of the resource.

findRootPathForClass

@Nullable
public static java.nio.file.Path findRootPathForClass(java.lang.Class<?> clazz)

Find the root path for the given class. If the class is found in a Jar file, then the result will be an absolute path to the jar file. If the resource is found in a directory, then the result will be the parent path of the given resource.

Parameters:

clazz - class to search for

Returns:

absolute path of the root of the resource.

getJarPathFromUrl

public static java.nio.file.Path getJarPathFromUrl(java.net.URL jarUrl)

Find the jar containing the given resource.

Parameters:

jarUrl - URL that came from a jar that needs to be parsed

Returns:

Path to the Jar containing the resource.

getDirectoriesFromJar

public static java.util.Set<java.nio.file.Path> getDirectoriesFromJar(java.nio.file.Path pathToJarFile)
                                                               throws java.io.IOException

Get all of the directory paths in a zip/jar file

Parameters:

pathToJarFile - location of the jarfile. can also be a zipfile

Returns:

set of directory paths relative to the root of the jar

Throws:

java.io.IOException

classToResourceName

public static java.lang.String classToResourceName(java.lang.Class<?> clazz)

Get the resource name for the class file for the given class

Parameters:

clazz - the class to convert

Returns:

resource name appropriate for using with ClassLoader.getResource(String)

classNameToResourceName

public static java.lang.String classNameToResourceName(java.lang.String className)

Get the resource name for the class file for the given class name

Parameters:

className - fully qualified classname to convert

Returns:

resource name appropriate for using with ClassLoader.getResource(String)

scanClassPath

public static java.util.Set<java.lang.String> scanClassPath(java.lang.String classPath,
                                            java.util.Set<java.lang.String> excludeJarSet)

Scan the classpath string provided, and collect a set of package paths found in jars and classes on the path.

Parameters:

classPath - the classpath string

excludeJarSet - a set of jars to exclude from scanning

Returns:

the results of the scan, as a set of package paths (separated by '/').

scanClassPath

public static java.util.Set<java.lang.String> scanClassPath(java.lang.String classPath,
                                            java.util.Set<java.lang.String> excludeJarSet,
                                            java.util.Set<java.lang.String> excludePrefixes,
                                            java.util.Set<java.lang.String> includePrefixes)

Scan the classpath string provided, and collect a set of package paths found in jars and classes on the path. On the resulting path set, first exclude those that match any exclude prefixes, and then include those that match a set of include prefixes.

Parameters:

classPath - the classpath string

excludeJarSet - a set of jars to exclude from scanning

excludePrefixes - a set of path prefixes that determine what is excluded

includePrefixes - a set of path prefixes that determine what is included

Returns:

the results of the scan, as a set of package paths (separated by '/').

scanClassPathWithExcludes

public static java.util.Set<java.lang.String> scanClassPathWithExcludes(java.lang.String classPath,
                                                        java.util.Set<java.lang.String> excludeJarSet,
                                                        java.util.Set<java.lang.String> excludePrefixes)

Scan the classpath string provided, and collect a set of package paths found in jars and classes on the path, excluding any that match a set of exclude prefixes.

Parameters:

classPath - the classpath string

excludeJarSet - a set of jars to exclude from scanning

excludePrefixes - a set of path prefixes that determine what is excluded

Returns:

the results of the scan, as a set of package paths (separated by '/').

scanClassPathWithIncludes

public static java.util.Set<java.lang.String> scanClassPathWithIncludes(java.lang.String classPath,
                                                        java.util.Set<java.lang.String> excludeJarSet,
                                                        java.util.Set<java.lang.String> includePrefixes)

Scan the classpath string provided, and collect a set of package paths found in jars and classes on the path, including only those that match a set of include prefixes.

Parameters:

classPath - the classpath string

excludeJarSet - a set of jars to exclude from scanning

includePrefixes - a set of path prefixes that determine what is included

Returns:

the results of the scan, as a set of package paths (separated by '/').