- * Returns the {@link java.io.FileFilter} used to determine which files are to be analyzed. - * An example would be an analyzer that inspected Java jar files. Implementors may use - * {@link org.owasp.dependencycheck.utils.FileFilterBuilder}.
+ * Returns the {@link java.io.FileFilter} used to determine which files are to be analyzed. An example would be an analyzer + * that inspected Java jar files. Implementors may use {@link org.owasp.dependencycheck.utils.FileFilterBuilder}. * * @return the file filter used to determine which files are to be analyzed * *- * If the analyzer returns null it will not cause additional files to be analyzed, but will be executed against - * every file loaded.
+ * If the analyzer returns null it will not cause additional files to be analyzed, but will be executed against every file + * loaded. */ protected abstract FileFilter getFileFilter(); @@ -125,11 +121,11 @@ public abstract class AbstractFileTypeAnalyzer extends AbstractAnalyzer implemen protected abstract void initializeFileTypeAnalyzer() throws Exception; /** - * Analyzes a given dependency. If the dependency is an archive, such as a WAR or EAR, the contents are extracted, - * scanned, and added to the list of dependencies within the engine. + * Analyzes a given dependency. If the dependency is an archive, such as a WAR or EAR, the contents are extracted, scanned, + * and added to the list of dependencies within the engine. * * @param dependency the dependency to analyze - * @param engine the engine scanning + * @param engine the engine scanning * @throws AnalysisException thrown if there is an analysis exception */ protected abstract void analyzeFileType(Dependency dependency, Engine engine) throws AnalysisException; @@ -144,7 +140,6 @@ public abstract class AbstractFileTypeAnalyzer extends AbstractAnalyzer implemen //- * Utility method to help in the creation of the extensions set. This constructs a new Set that can be used in a - * final static declaration.
+ * Utility method to help in the creation of the extensions set. This constructs a new Set that can be used in a final static + * declaration. * ** This implementation was copied from @@ -226,6 +219,5 @@ public abstract class AbstractFileTypeAnalyzer extends AbstractAnalyzer implemen return set; } - //
- * An analyzer that extracts files from archives and ensures any supported files contained within the archive are added - * to the dependency list.
+ * An analyzer that extracts files from archives and ensures any supported files contained within the archive are added to the + * dependency list. * * @author Jeremy Long */ @@ -93,8 +100,8 @@ public class ArchiveAnalyzer extends AbstractFileTypeAnalyzer { */ private static final SetUtility class for building useful {@link FileFilter} instances for - * {@link org.owasp.dependencycheck.analyzer.AbstractFileTypeAnalyzer} implementations. The built filter uses - * {@link OrFileFilter} to logically OR the given filter conditions. Example usage:
+ *+ * Utility class for building useful {@link FileFilter} instances for + * {@link org.owasp.dependencycheck.analyzer.AbstractFileTypeAnalyzer} implementations. The built filter uses {@link OrFileFilter} + * to logically OR the given filter conditions. Example usage:
* *
* FileFilter filter = FileFilterBuilder.newInstance().addExtensions("jar", "war").build();
@@ -41,13 +45,21 @@ import java.util.*;
*/
public class FileFilterBuilder {
- private Set filenames = new HashSet();
- private Set extensions = new HashSet();
- private List fileFilters = new ArrayList();
+ /**
+ * A set of filenames to filter.
+ */
+ private final Set filenames = new HashSet();
+ /**
+ * A set of extensions to filter.
+ */
+ private final Set extensions = new HashSet();
+ /**
+ * An array list of file filters.
+ */
+ private final List fileFilters = new ArrayList();
/**
- * Create a new instance and return it. This method is for convenience in using the builder pattern within a single
- * statement.
+ * Create a new instance and return it. This method is for convenience in using the builder pattern within a single statement.
*
* @return a new builder instance
*/
@@ -111,7 +123,7 @@ public class FileFilterBuilder {
if (filenames.isEmpty() && extensions.isEmpty() && fileFilters.isEmpty()) {
throw new IllegalStateException("May only be invoked after at least one add... method has been invoked.");
}
- OrFileFilter filter = new OrFileFilter();
+ final OrFileFilter filter = new OrFileFilter();
if (!filenames.isEmpty()) {
filter.addFileFilter(new NameFileFilter(new ArrayList(filenames)));
}