org.apache.cxf.common.util

Class ClasspathScanner

java.lang.Object

org.apache.cxf.common.util.ClasspathScanner

public class ClasspathScanner
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALL_CLASS_FILES
static java.lang.String	ALL_FILES
static java.lang.String	CLASSPATH_URL_SCHEME
static java.lang.String	WILDCARD

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClasspathScanner()

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.lang.Class<? extends java.lang.annotation.Annotation>,java.util.Collection<java.lang.Class<?>>>	findClasses(java.util.Collection<java.lang.String> basePackages, java.lang.Class<? extends java.lang.annotation.Annotation>... annotations) Scans list of base packages for all classes marked with specific annotations.
static java.util.Map<java.lang.Class<? extends java.lang.annotation.Annotation>,java.util.Collection<java.lang.Class<?>>>	findClasses(java.util.Collection<java.lang.String> basePackages, java.util.List<java.lang.Class<? extends java.lang.annotation.Annotation>> annotations) Scans list of base packages for all classes marked with specific annotations.
static java.util.Map<java.lang.Class<? extends java.lang.annotation.Annotation>,java.util.Collection<java.lang.Class<?>>>	findClasses(java.util.Collection<java.lang.String> basePackages, java.util.List<java.lang.Class<? extends java.lang.annotation.Annotation>> annotations, java.lang.ClassLoader loader)
static java.util.Map<java.lang.Class<? extends java.lang.annotation.Annotation>,java.util.Collection<java.lang.Class<?>>>	findClasses(java.lang.String basePackage, java.lang.Class<? extends java.lang.annotation.Annotation>... annotations) Scans list of base packages for all classes marked with specific annotations.
protected java.util.Map<java.lang.Class<? extends java.lang.annotation.Annotation>,java.util.Collection<java.lang.Class<?>>>	findClassesInternal(java.util.Collection<java.lang.String> basePackages, java.util.List<java.lang.Class<? extends java.lang.annotation.Annotation>> annotations, java.lang.ClassLoader loader)
static java.util.List<java.net.URL>	findResources(java.util.Collection<java.lang.String> basePackages, java.lang.String extension) Scans list of base packages for all resources with the given extension.
static java.util.List<java.net.URL>	findResources(java.util.Collection<java.lang.String> basePackages, java.lang.String extension, java.lang.ClassLoader loader)
static java.util.List<java.net.URL>	findResources(java.lang.String basePackage, java.lang.String extension) Scans list of base packages for all resources with the given extension.
static java.util.List<java.net.URL>	findResources(java.lang.String basePackage, java.lang.String extension, java.lang.ClassLoader loader) Scans list of base packages for all resources with the given extension.
protected java.util.List<java.net.URL>	findResourcesInternal(java.util.Collection<java.lang.String> basePackages, java.lang.String extension, java.lang.ClassLoader loader)
static java.util.Set<java.lang.String>	parsePackages(java.lang.String packagesAsCsv)

Methods inherited from class java.lang.Object

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

Field Detail

ALL_FILES

public static final java.lang.String ALL_FILES

See Also:

Constant Field Values

ALL_CLASS_FILES

public static final java.lang.String ALL_CLASS_FILES

See Also:

Constant Field Values

WILDCARD

public static final java.lang.String WILDCARD

See Also:

Constant Field Values

CLASSPATH_URL_SCHEME

public static final java.lang.String CLASSPATH_URL_SCHEME

See Also:

Constant Field Values

Constructor Detail

ClasspathScanner

protected ClasspathScanner()

Method Detail

findClasses

@SafeVarargs
public static java.util.Map<java.lang.Class<? extends java.lang.annotation.Annotation>,java.util.Collection<java.lang.Class<?>>> findClasses(java.lang.String basePackage,
                                                                                                                                                          java.lang.Class<? extends java.lang.annotation.Annotation>... annotations)
                                                                                                                                                   throws java.io.IOException,
                                                                                                                                                          java.lang.ClassNotFoundException

Scans list of base packages for all classes marked with specific annotations.

Parameters:

basePackage - base package

annotations - annotations to discover

Returns:

all discovered classes grouped by annotations they belong too

Throws:

java.io.IOException - class metadata is not readable

java.lang.ClassNotFoundException - class not found

findClasses

@SafeVarargs
public static java.util.Map<java.lang.Class<? extends java.lang.annotation.Annotation>,java.util.Collection<java.lang.Class<?>>> findClasses(java.util.Collection<java.lang.String> basePackages,
                                                                                                                                                          java.lang.Class<? extends java.lang.annotation.Annotation>... annotations)
                                                                                                                                                   throws java.io.IOException,
                                                                                                                                                          java.lang.ClassNotFoundException

Scans list of base packages for all classes marked with specific annotations.

Parameters:

basePackages - list of base packages

annotations - annotations to discover

Returns:

all discovered classes grouped by annotations they belong too

Throws:

java.io.IOException - class metadata is not readable

java.lang.ClassNotFoundException - class not found

findClasses

public static java.util.Map<java.lang.Class<? extends java.lang.annotation.Annotation>,java.util.Collection<java.lang.Class<?>>> findClasses(java.util.Collection<java.lang.String> basePackages,
                                                                                                                                             java.util.List<java.lang.Class<? extends java.lang.annotation.Annotation>> annotations)
                                                                                                                                      throws java.io.IOException,
                                                                                                                                             java.lang.ClassNotFoundException

Scans list of base packages for all classes marked with specific annotations.

Parameters:

basePackages - list of base packages

annotations - annotations to discover

Returns:

all discovered classes grouped by annotations they belong too

Throws:

java.io.IOException - class metadata is not readable

java.lang.ClassNotFoundException - class not found

findClasses

public static java.util.Map<java.lang.Class<? extends java.lang.annotation.Annotation>,java.util.Collection<java.lang.Class<?>>> findClasses(java.util.Collection<java.lang.String> basePackages,
                                                                                                                                             java.util.List<java.lang.Class<? extends java.lang.annotation.Annotation>> annotations,
                                                                                                                                             java.lang.ClassLoader loader)
                                                                                                                                      throws java.io.IOException,
                                                                                                                                             java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

findClassesInternal

protected java.util.Map<java.lang.Class<? extends java.lang.annotation.Annotation>,java.util.Collection<java.lang.Class<?>>> findClassesInternal(java.util.Collection<java.lang.String> basePackages,
                                                                                                                                                 java.util.List<java.lang.Class<? extends java.lang.annotation.Annotation>> annotations,
                                                                                                                                                 java.lang.ClassLoader loader)
                                                                                                                                          throws java.io.IOException,
                                                                                                                                                 java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

findResources

public static java.util.List<java.net.URL> findResources(java.lang.String basePackage,
                                                         java.lang.String extension)
                                                  throws java.io.IOException

Scans list of base packages for all resources with the given extension.

Parameters:

basePackage - base package

extension - the extension matching resources needs to have

Returns:

list of all discovered resource URLs

Throws:

java.io.IOException - resource is not accessible

findResources

public static java.util.List<java.net.URL> findResources(java.lang.String basePackage,
                                                         java.lang.String extension,
                                                         java.lang.ClassLoader loader)
                                                  throws java.io.IOException

Scans list of base packages for all resources with the given extension.

Parameters:

basePackage - base package

extension - the extension matching resources needs to have

Returns:

list of all discovered resource URLs

Throws:

java.io.IOException - resource is not accessible

findResources

public static java.util.List<java.net.URL> findResources(java.util.Collection<java.lang.String> basePackages,
                                                         java.lang.String extension)
                                                  throws java.io.IOException

Scans list of base packages for all resources with the given extension.

Parameters:

basePackages - list of base packages

extension - the extension matching resources needs to have

Returns:

list of all discovered resource URLs

Throws:

java.io.IOException - resource is not accessible

findResources

public static java.util.List<java.net.URL> findResources(java.util.Collection<java.lang.String> basePackages,
                                                         java.lang.String extension,
                                                         java.lang.ClassLoader loader)
                                                  throws java.io.IOException

Throws:

java.io.IOException

parsePackages

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

findResourcesInternal

protected java.util.List<java.net.URL> findResourcesInternal(java.util.Collection<java.lang.String> basePackages,
                                                             java.lang.String extension,
                                                             java.lang.ClassLoader loader)
                                                      throws java.io.IOException

Throws:

java.io.IOException