com.screenscraper.profiling

Class AbstractFilter

java.lang.Object

com.screenscraper.profiling.AbstractFilter

All Implemented Interfaces:

ProfilingFilter

Direct Known Subclasses:

BlacklistedClassFieldProfilingFilter, WhitelistedClassFieldProfilingFilter

public abstract class AbstractFilter
extends java.lang.Object
implements ProfilingFilter

Basic filter containing classes, objects, and packages which should be filtered in some way, based on the specific implementation Author: Mike Date: 1/12/12 Time: 5:04 PM

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.Class,java.util.Set<java.lang.String>>	classes A Map from a Class to filter to a set of values associated with the class.
protected static org.apache.log4j.Logger	LOGGER Used for logging.
protected java.util.Set<java.lang.Object>	objects A set of objects given to the filter
protected java.util.Set<java.lang.String>	packages The set of packages names being used by the filter

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFilter() Build a basic filter
protected	AbstractFilter(java.io.File configFile) Build a filter from a file.
protected	AbstractFilter(java.lang.String configFile) Build a filter from a file.

Method Summary

Modifier and Type	Method and Description
void	addClass(java.lang.Class clazz) Adds a class to the filter
void	addField(java.lang.Class clazz, java.lang.String fieldName) Adds a field to the filter.
void	addObject(java.lang.Object object) Adds an object to the set of objects used by this filter
void	addPackage(java.lang.String pack) Adds a package to the filter
java.util.Map<java.lang.Class,java.util.Set<java.lang.String>>	getClassesCopy() Returns a copy of the classes used by this filter
protected java.lang.Class	getMainClass(java.lang.Class clazz) Strips off all the array tags to find out the type of the object
java.util.Set<java.lang.Object>	getObjectsCopy() Returns a shallow copy of the objects used by this filter
java.util.Set<java.lang.String>	getPackagesCopy() Returns a copy of the packages used by this filter
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.screenscraper.profiling.ProfilingFilter

duplicateFilter, shouldVisitChild

Field Detail

LOGGER

protected static final org.apache.log4j.Logger LOGGER

Used for logging.

packages

protected java.util.Set<java.lang.String> packages

The set of packages names being used by the filter

classes

protected java.util.Map<java.lang.Class,java.util.Set<java.lang.String>> classes

A Map from a Class to filter to a set of values associated with the class. In general, this would be fields in the class

objects

protected java.util.Set<java.lang.Object> objects

A set of objects given to the filter

Constructor Detail

AbstractFilter

protected AbstractFilter()

Build a basic filter

AbstractFilter

protected AbstractFilter(@NotNull
                         java.lang.String configFile)
                  throws java.io.IOException

Build a filter from a file. The format is given as one line per package/class, and under each class any line starting with a - will be associated with that class. Comment lines begin with a #

Parameters:

configFile - The file containing the filter information

Throws:

java.io.IOException - On error reading from the file

AbstractFilter

protected AbstractFilter(@NotNull
                         java.io.File configFile)
                  throws java.io.IOException

Build a filter from a file. The format is given as one line per package/class, and under each class any line starting with a - will be associated with that class. Comment lines begin with a #

Parameters:

configFile - The file containing the filter information

Throws:

java.io.IOException - On error reading from the file

Method Detail

addObject

public void addObject(java.lang.Object object)

Adds an object to the set of objects used by this filter

Parameters:

object - The object to add to the filter

addField

public void addField(java.lang.Class clazz,
                     @Nullable
                     java.lang.String fieldName)

Adds a field to the filter. A field is associated with the given class

Parameters:

clazz - The class to add a field value to

fieldName - The name of the field to add

addPackage

public void addPackage(@Nullable
                       java.lang.String pack)

Adds a package to the filter

Parameters:

pack - The name of the package to add, as xx.xxx.xxx

addClass

public void addClass(@Nullable
                     java.lang.Class clazz)

Adds a class to the filter

Parameters:

clazz - The class to add

getClassesCopy

@NotNull
public java.util.Map<java.lang.Class,java.util.Set<java.lang.String>> getClassesCopy()

Returns a copy of the classes used by this filter

Returns:

A copy of the classes used by the filter

getObjectsCopy

@NotNull
public java.util.Set<java.lang.Object> getObjectsCopy()

Returns a shallow copy of the objects used by this filter

Returns:

A shallow copy of the objects used by this filter

getPackagesCopy

@NotNull
public java.util.Set<java.lang.String> getPackagesCopy()

Returns a copy of the packages used by this filter

Returns:

A copy of the packages used by this filter

getMainClass

@NotNull
protected java.lang.Class getMainClass(@NotNull
                                                 java.lang.Class clazz)

Strips off all the array tags to find out the type of the object

Parameters:

clazz - The class in question

Returns:

The base class, such as String for String[][]

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object