com.screenscraper.profiling

Class BlacklistedClassFieldProfilingFilter

java.lang.Object

com.screenscraper.profiling.AbstractFilter

com.screenscraper.profiling.BlacklistedClassFieldProfilingFilter

All Implemented Interfaces:

ProfilingFilter

public class BlacklistedClassFieldProfilingFilter
extends AbstractFilter

A filter that blacklists everything in it. Anything not listed will be passed through the filter, everything else will be filtered out Author: Mike Date: 1/6/12 Time: 2:22 PM

Field Summary

Fields inherited from class com.screenscraper.profiling.AbstractFilter

classes, LOGGER, objects, packages

Constructor Summary

Constructors

Constructor and Description
BlacklistedClassFieldProfilingFilter() Builds an empty filter
BlacklistedClassFieldProfilingFilter(BlacklistedClassFieldProfilingFilter filter) Builds a filter by using the same values as another filter
BlacklistedClassFieldProfilingFilter(java.io.File configFile) Build a filter from a file.
BlacklistedClassFieldProfilingFilter(java.lang.String configFile) Build a filter from a file.

Method Summary

Modifier and Type	Method and Description
ProfilingFilter	duplicateFilter() Returns a duplicate copy of this filter (deep enough that it is immutable)
boolean	shouldVisitChild(java.lang.Object parent, java.lang.Object child, java.lang.String fieldName) Determines whether or not to visit the child given it's parent and the name of the field in the parent that the child came from

Methods inherited from class com.screenscraper.profiling.AbstractFilter

addClass, addField, addObject, addPackage, getClassesCopy, getMainClass, getObjectsCopy, getPackagesCopy, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BlacklistedClassFieldProfilingFilter

public BlacklistedClassFieldProfilingFilter()

Builds an empty filter

BlacklistedClassFieldProfilingFilter

public BlacklistedClassFieldProfilingFilter(@NotNull
                                            BlacklistedClassFieldProfilingFilter filter)

Builds a filter by using the same values as another filter

Parameters:

filter - A filter to duplicate

BlacklistedClassFieldProfilingFilter

public BlacklistedClassFieldProfilingFilter(@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

BlacklistedClassFieldProfilingFilter

public BlacklistedClassFieldProfilingFilter(@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

duplicateFilter

@NotNull
public ProfilingFilter duplicateFilter()

Description copied from interface: ProfilingFilter

Returns a duplicate copy of this filter (deep enough that it is immutable)

Returns:

The new filter

shouldVisitChild

public boolean shouldVisitChild(@Nullable
                                java.lang.Object parent,
                                @Nullable
                                java.lang.Object child,
                                java.lang.String fieldName)

Description copied from interface: ProfilingFilter

Determines whether or not to visit the child given it's parent and the name of the field in the parent that the child came from

Parameters:

parent - The parent object

child - The child object that we are thinking of visiting

fieldName - The name of the field in the parent that the child came from

Returns:

True if we should visit this particular child