io.devcon5.classutils

Class JarScanner

java.lang.Object

io.devcon5.classutils.JarScanner

public class JarScanner
extends Object

A scanner for contents of jar files. The scanner supports scanning for packages and contents.

Constructor Summary

Constructors

Constructor and Description
JarScanner()

Method Summary

Modifier and Type	Method and Description
JarScanner	addJar(Collection<URL> jars) Adds a jar file to be scanned
JarScanner	addJar(URL... jar) Adds a jar file to be scanned
JarScanner	ignore(Collection<String> folders) Excludes the specified folders from scanning.
JarScanner	ignore(String... folder) Excludes the specified folders from scanning.
Collection<String>	scanClasses() Scans the specified jars for packages and returns a list of all packages found in that jar.
Collection<String>	scanPackages() Scans the specified jars for packages and returns a list of all packages found in that jar.

Methods inherited from class java.lang.Object

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

Constructor Detail

JarScanner

public JarScanner()

Method Detail

ignore

public JarScanner ignore(Collection<String> folders)

Excludes the specified folders from scanning. The ignore pattern checks matches packages and classes starting with the specified string.

Parameters:

folders - folders to be ignored

Returns:

this scanner

ignore

public JarScanner ignore(String... folder)

Excludes the specified folders from scanning. The ignore pattern checks matches packages and classes starting with the specified string.

Parameters:

folder - folder(s) to be ignored

Returns:

this scanner

addJar

public JarScanner addJar(URL... jar)

Adds a jar file to be scanned

Parameters:

jar - jar(s) to be added to the scanner

Returns:

this scanner

addJar

public JarScanner addJar(Collection<URL> jars)

Adds a jar file to be scanned

Parameters:

jars - jars to be added to the scanner

Returns:

this scanner

scanPackages

public Collection<String> scanPackages()

Scans the specified jars for packages and returns a list of all packages found in that jar. The scanner makes no distinction between packages and folders.

Returns:

a collection of all package names found in the jar

scanClasses

public Collection<String> scanClasses()

Scans the specified jars for packages and returns a list of all packages found in that jar. The scanner makes no distinction between packages and folders.

Returns:

a collection of all classes names found in the jar