com.screenscraper.profiling

Class WhitelistedClassFieldProfilingFilter

java.lang.Object

com.screenscraper.profiling.AbstractFilter

com.screenscraper.profiling.WhitelistedClassFieldProfilingFilter

All Implemented Interfaces:

ProfilingFilter

public class WhitelistedClassFieldProfilingFilter
extends AbstractFilter

A filter for profiling that blocks everything not whitelisted 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
WhitelistedClassFieldProfilingFilter() Builds an empty white list filter
WhitelistedClassFieldProfilingFilter(java.io.File configFile) Build a filter from a file.
WhitelistedClassFieldProfilingFilter(java.lang.String configFile) Build a filter from a file.
WhitelistedClassFieldProfilingFilter(WhitelistedClassFieldProfilingFilter filter) Builds a white list filter by duplicating another white list filter

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

WhitelistedClassFieldProfilingFilter

public WhitelistedClassFieldProfilingFilter()

Builds an empty white list filter

WhitelistedClassFieldProfilingFilter

public WhitelistedClassFieldProfilingFilter(@NotNull
                                            WhitelistedClassFieldProfilingFilter filter)

Builds a white list filter by duplicating another white list filter

Parameters:

filter - The filter to duplicate

WhitelistedClassFieldProfilingFilter

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

WhitelistedClassFieldProfilingFilter

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