jodd.io.findfile.ClasspathScanner Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jodd Show documentation

Jodd utility library

There is a newer version: 3.4.1

// Copyright (c) 2003-2010, Jodd Team (jodd.org). All Rights Reserved.

package jodd.io.findfile;

import jodd.util.ClassLoaderUtil;

import java.net.URL;
import java.io.File;

/**
 * Public-oriented version of {@link FindClass}, a classpath scanner.
 */
public abstract class ClasspathScanner extends FindClass {

	// ---------------------------------------------------------------- missing accessors

	public boolean isIncludeResources() {
		return includeResources;
	}

	public void setIncludeResources(boolean includeResources) {
		this.includeResources = includeResources;
	}

	public ClasspathScanner includeResources(boolean includeResources) {
		setIncludeResources(includeResources);
		return this;
	}

	public boolean isIgnoreException() {
		return ignoreException;
	}

	public void setIgnoreException(boolean ignoreException) {
		this.ignoreException = ignoreException;
	}

	public ClasspathScanner ignoreException(boolean ignoreException) {
		setIgnoreException(ignoreException);
		return this;
	}


	// ---------------------------------------------------------------- fluent interface

	public ClasspathScanner systemJars(String... jars) {
		setSystemJars(jars);
		return this;
	}

	public ClasspathScanner includeJars(String... jars) {
		setIncludedJars(jars);
		return this;
	}

	public ClasspathScanner excludeJars(String... jars) {
		setExcludedJars(jars);
		return this;
	}

	public ClasspathScanner include(String... entries) {
		setIncludedEntries(entries);
		return this;
	}

	public ClasspathScanner exclude(String... entries) {
		setExcludedEntries(entries);
		return this;
	}


	// ---------------------------------------------------------------- public scanners

	/**
	 * Scans provided classpath.
	 */
	public void scan(URL... urls) {
		scanUrls(urls);
	}

	/**
	 * Scans full class path.
	 */
	public void scanFullClasspath() {
		scanUrls(ClassLoaderUtil.getFullClassPath(ClasspathScanner.class));
	}

	/**
	 * Scans provided paths.
	 */
	public void scan(File... paths) {
		scanPaths(paths);
	}

	/**
	 * Scans provided paths.
	 */
	public void scan(String... paths) {
		scanPaths(paths);
	}

}