com.avaje.ebeaninternal.server.util

Class ClassPathSearchFilter

java.lang.Object

com.avaje.ebeaninternal.server.util.ClassPathSearchFilter

public class ClassPathSearchFilter
extends Object

Used to reduce the classes searched by excluding jars and packages.

Constructor Summary

Constructors

Constructor and Description
ClassPathSearchFilter()

Method Summary

Methods

Modifier and Type	Method and Description
void	addDefaultExcludePackages() Add some packages which by default will be excluded from a search.
void	clearExcludePackages() Clear all entries from the exclude packages list.
protected boolean	containedIn(HashSet<String> set, String match) Helper method to determine is a match is contained in the set.
void	excludeJar(String jarName) Add a jar to explicitly exclude in the search.
void	excludePackage(String pckgName) Add a package to explicitly exclude in the search.
Set<String>	getIncludePackages() Return the explicit packages that should be searched.
void	includeJar(String jarName) Add a jar to explicitly include in the search.
void	includePackage(String pckgName) Add a package to explicitly include in the search.
boolean	isSearchJar(String jarName) Return true if the jar should be included in the search.
boolean	isSearchPackage(String packageName) Return true if the package should be included in the search.
void	setDefaultJarMatch(boolean defaultJarMatch) Set the default for jar matching when a jar is neither explicitly included or excluded.
void	setDefaultPackageMatch(boolean defaultPackageMatch) Set the default for package matching when a package is neither explicitly included or excluded.
void	setEbeanJarPrefix(String ebeanJarPrefix) Set the name of the ebean jar file.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassPathSearchFilter

public ClassPathSearchFilter()

Method Detail

setEbeanJarPrefix

public void setEbeanJarPrefix(String ebeanJarPrefix)

Set the name of the ebean jar file. Used with class path search to find the "Meta" entity beans that are contained within the ebean jar.

You only need to set this if the ebean jar file name starts with something other than ebean.

getIncludePackages

public Set<String> getIncludePackages()

Return the explicit packages that should be searched.

addDefaultExcludePackages

public void addDefaultExcludePackages()

Add some packages which by default will be excluded from a search.

This includes java, javax, etc.

This is not used when the includePackages is set, but can speed a search when includePackages has not been set.

clearExcludePackages

public void clearExcludePackages()

Clear all entries from the exclude packages list.

This includes the entries added by addDefaultExcludePackages() which is done on construction.

setDefaultJarMatch

public void setDefaultJarMatch(boolean defaultJarMatch)

Set the default for jar matching when a jar is neither explicitly included or excluded.

setDefaultPackageMatch

public void setDefaultPackageMatch(boolean defaultPackageMatch)

Set the default for package matching when a package is neither explicitly included or excluded.

includePackage

public void includePackage(String pckgName)

Add a package to explicitly include in the search.

excludePackage

public void excludePackage(String pckgName)

Add a package to explicitly exclude in the search.

excludeJar

public void excludeJar(String jarName)

Add a jar to explicitly exclude in the search.

includeJar

public void includeJar(String jarName)

Add a jar to explicitly include in the search.

isSearchPackage

public boolean isSearchPackage(String packageName)

Return true if the package should be included in the search.

isSearchJar

public boolean isSearchJar(String jarName)

Return true if the jar should be included in the search.

containedIn

protected boolean containedIn(HashSet<String> set,
                  String match)

Helper method to determine is a match is contained in the set.