com.jwebmp.guicedinjection.GuiceConfig Maven / Gradle / Ivy

Go to download
package com.jwebmp.guicedinjection;

import com.google.inject.Singleton;

import javax.validation.constraints.NotNull;
import java.io.Serializable;

/**
 * The configuration class for Guice Context and the Classpath Scanner
 */
@Singleton
@SuppressWarnings("all")
public class GuiceConfig>
		implements Serializable
{
	private static final long serialVersionUID = 1L;
	/**
	 * Whether to include field information right now
	 */
	private boolean fieldInfo;
	/**
	 * Whether field scanning should be performed
	 */
	private boolean fieldScanning;
	/**
	 * Whether the field annotation scanning should occur
	 */
	private boolean annotationScanning;
	/**
	 * If method information should be allowed
	 */
	private boolean methodInfo;
	/**
	 * If the field visibility should be ignored
	 */
	private boolean ignoreFieldVisibility;
	/**
	 * If the method visibility should be ignored
	 */
	private boolean ignoreMethodVisibility;
	/**
	 * White list the scanning. Highly Recommended
	 */
	private boolean whiteList;
	/**
	 * Whether or not to log very verbose
	 */
	private boolean verbose;
	/**
	 * If classpath scanning is enabled.
	 */
	private boolean classpathScanning;
	/**
	 * Excludes modules and jars from scanning - may and may not make it faster depending on your pc
	 */
	private boolean excludeModulesAndJars;
	/**
	 * Excludes paths from scanning - excellent for minizing path scanning on web application
	 */
	private boolean excludePaths;

	/**
	 * Configures the Guice Context and Reflection Identifier
	 */
	public GuiceConfig()
	{
		//No Config
	}

	/**
	 * If field scanning should be enabled
	 *
	 * @return mandatory result
	 */
	public boolean isFieldScanning()
	{
		return fieldScanning;
	}

	/**
	 * Enables scanning of fields
	 *
	 * @param fieldScanning
	 * 		If field scanning should happen
	 *
	 * @return Mandatory field scanning
	 */
	@SuppressWarnings("unchecked")
	@NotNull
	public J setFieldScanning(boolean fieldScanning)
	{
		this.fieldScanning = fieldScanning;
		return (J) this;
	}

	/**
	 * Enables scanning of field annotations
	 *
	 * @return not null
	 */
	public boolean isAnnotationScanning()
	{
		return annotationScanning;
	}

	/**
	 * Enables scanning of field annotations
	 *
	 * @param annotationScanning
	 * 		if the field annotation scanning
	 *
	 * @return the field annotation scanning
	 */
	@SuppressWarnings("unchecked")
	@NotNull
	public J setAnnotationScanning(boolean annotationScanning)
	{
		this.annotationScanning = annotationScanning;
		return (J) this;
	}

	/**
	 * If method info should be kept
	 *
	 * @return always this
	 */
	public boolean isMethodInfo()
	{
		return methodInfo;
	}

	/**
	 * Sets if method info should be kept
	 *
	 * @param methodInfo
	 * 		if method information should be collected
	 *
	 * @return always this
	 */
	@SuppressWarnings("unchecked")
	@NotNull
	public J setMethodInfo(boolean methodInfo)
	{
		this.methodInfo = methodInfo;
		return (J) this;
	}

	/**
	 * Sets to ignore field visibility
	 *
	 * @return if field visibility is being used
	 */
	public boolean isIgnoreFieldVisibility()
	{
		return ignoreFieldVisibility;
	}

	/**
	 * Sets to ignore field visibility
	 *
	 * @param ignoreFieldVisibility
	 * 		if the field should be visible
	 *
	 * @return always this
	 */
	@SuppressWarnings("unchecked")
	@NotNull
	public J setIgnoreFieldVisibility(boolean ignoreFieldVisibility)
	{
		this.ignoreFieldVisibility = ignoreFieldVisibility;
		return (J) this;
	}

	/**
	 * Sets to ignore method visibility
	 *
	 * @return if method is visibility ignored
	 */
	public boolean isIgnoreMethodVisibility()
	{
		return ignoreMethodVisibility;
	}

	/**
	 * Sets to ignore method visibility
	 *
	 * @param ignoreMethodVisibility
	 * 		the ignore method
	 *
	 * @return always This
	 */
	@SuppressWarnings("unchecked")
	@NotNull
	public J setIgnoreMethodVisibility(boolean ignoreMethodVisibility)
	{
		this.ignoreMethodVisibility = ignoreMethodVisibility;
		return (J) this;
	}

	/**
	 * Sets if packages must be white listed.
	 * 
	 * Use META-INF/services/com.jwebmp.guiceinjection.scanners.IPackageContentsScanner to register your packages
	 *
	 * @return if whitelisting is enabled
	 */
	public boolean isWhiteList()
	{
		return whiteList;
	}

	/**
	 * Sets if packages must be white listed.
	 * * 
	 * * Use META-INF/services/com.jwebmp.guiceinjection.scanners.IPackageContentsScanner to register your packages
	 *
	 * @param whiteList
	 * 		if packages should be white listed
	 *
	 * @return Always this
	 */
	@SuppressWarnings("unchecked")
	@NotNull
	public J setWhiteList(boolean whiteList)
	{
		this.whiteList = whiteList;
		return (J) this;
	}

	/**
	 * Returns the field information included in the scan result
	 *
	 * @return if field info is included
	 */
	public boolean isFieldInfo()
	{
		return fieldInfo;
	}

	/**
	 * Sets if the field info should be in the field result
	 *
	 * @param fieldInfo
	 * 		if field info should be scanned
	 *
	 * @return always this object
	 */
	@SuppressWarnings("unchecked")
	@NotNull
	public J setFieldInfo(boolean fieldInfo)
	{
		this.fieldInfo = fieldInfo;
		return (J) this;
	}

	public boolean isVerbose()
	{
		return verbose;
	}

	@SuppressWarnings("unchecked")
	@NotNull
	public J setVerbose(boolean verbose)
	{
		this.verbose = verbose;

		return (J) this;
	}

	public boolean isClasspathScanning()
	{
		return classpathScanning;
	}

	@SuppressWarnings("unchecked")
	@NotNull
	public J setClasspathScanning(boolean classpathScanning)
	{
		this.classpathScanning = classpathScanning;
		return (J) this;
	}

	/**
	 * Excludes modules and jars from scanning - may and may not make it faster depending on your pc
	 *
	 * @return
	 */
	public boolean isExcludeModulesAndJars()
	{
		return excludeModulesAndJars;
	}

	/**
	 * Excludes modules and jars from scanning - may and may not make it faster depending on your pc
	 *
	 * @param excludeModulesAndJars
	 *
	 * @return J
	 */
	public J setExcludeModulesAndJars(boolean excludeModulesAndJars)
	{
		this.excludeModulesAndJars = excludeModulesAndJars;
		return (J) this;
	}

	/**
	 * Excludes paths from scanning - excellent for minizing path scanning on web application
	 *
	 * @return boolean
	 */
	public boolean isExcludePaths()
	{
		return excludePaths;
	}

	/**
	 * Excludes paths from scanning - excellent for minizing path scanning on web application
	 *
	 * @param excludePaths
	 * 		If the default paths must be automatically excluded
	 *
	 * @return J
	 */
	public J setExcludePaths(boolean excludePaths)
	{
		this.excludePaths = excludePaths;
		return (J) this;
	}

	@Override
	public String toString()
	{
		return "GuiceConfig{" +
		       "fieldInfo=" + fieldInfo +
		       ", fieldScanning=" + fieldScanning +
		       ", annotationScanning=" + annotationScanning +
		       ", methodInfo=" + methodInfo +
		       ", ignoreFieldVisibility=" + ignoreFieldVisibility +
		       ", ignoreMethodVisibility=" + ignoreMethodVisibility +
		       ", whiteList=" + whiteList +
		       ", verbose=" + verbose +
		       ", classpathScanning=" + classpathScanning +
		       ", excludeModulesAndJars=" + excludeModulesAndJars +
		       ", excludePaths=" + excludePaths +
		       '}';
	}
}