Index (pattern-detection-library 1.0.17 API)

A B C D E F G I M N P S T V W
All Classes and Interfaces|All Packages|Serialized Form

A

AbstractClue - Class in com.redhat.parodos.patterndetection.clue: AbstractClue contains the @see WorkContextDelegate, @see NameMatchingDelegate, Name and continueToRunIfDetected which are also common to all @see Clue references.
AbstractClue() - Constructor for class com.redhat.parodos.patterndetection.clue.AbstractClue
AbstractClue.Builder<T extends AbstractClue.Builder<T>> - Class in com.redhat.parodos.patterndetection.clue
addTheseToAllCluesRequired(List<Clue>) - Method in class com.redhat.parodos.patterndetection.pattern.BasicPatternImpl.Builder.PatternImplBuilder
addTheseToDesiredPatterns(List<Pattern>) - Method in class com.redhat.parodos.patterndetection.context.WorkContextDelegate.WorkContextBuilder
addTheseToOneOfTheseClues(List<Clue>) - Method in class com.redhat.parodos.patterndetection.pattern.BasicPatternImpl.Builder.PatternImplBuilder
addThisToAllAreRequiredClues(Clue) - Method in class com.redhat.parodos.patterndetection.pattern.BasicPatternImpl.Builder.PatternImplBuilder
addThisToDesiredPatterns(Pattern) - Method in class com.redhat.parodos.patterndetection.context.WorkContextDelegate.WorkContextBuilder
addThiToOneIsRequiredClues(Clue) - Method in class com.redhat.parodos.patterndetection.pattern.BasicPatternImpl.Builder.PatternImplBuilder
aNewNameMatchingDelegate() - Static method in class com.redhat.parodos.patterndetection.clue.delegate.NameMatchingDelegate.Builder
aNewPattern() - Static method in class com.redhat.parodos.patterndetection.pattern.BasicPatternImpl.Builder
areAllPatternsDetected(WorkReport) - Method in class com.redhat.parodos.patterndetection.context.WorkContextDelegate: Compares the DETECT_PATTERNS to the DESIRED_PATTERNS to see if all were detected

B

BasicPatternImpl - Class in com.redhat.parodos.patterndetection.pattern: An implementation of @see Pattern that will serve most Pattern Detection needs allAreRequiredClues - every @see Clue added to this list needs to be detected for the @see Pattern to be considered detected onlyOneIsRequiredClues - only one @see Clue from this list needs to be detected for the @see Pattern to be considered detected If both onlyOneIsRequiredClues and allAreRequiredClues are configured, then all of the @Clue in allAreRequiredClues must be detected AND one of the @see Clue in the onlyOneIsRequiredClues must be detected
BasicPatternImpl.Builder - Class in com.redhat.parodos.patterndetection.pattern
BasicPatternImpl.Builder.PatternImplBuilder - Class in com.redhat.parodos.patterndetection.pattern
build() - Method in class com.redhat.parodos.patterndetection.clue.ContentsClueImpl.Builder
build() - Method in class com.redhat.parodos.patterndetection.clue.delegate.NameMatchingDelegate.Builder.NameMatchingDelegateBuilder
build() - Method in class com.redhat.parodos.patterndetection.clue.NameClueImpl.Builder
build() - Method in class com.redhat.parodos.patterndetection.context.WorkContextDelegate.WorkContextBuilder
build() - Method in class com.redhat.parodos.patterndetection.pattern.BasicPatternImpl.Builder.PatternImplBuilder
build(S) - Method in class com.redhat.parodos.patterndetection.clue.AbstractClue.Builder
builder() - Static method in class com.redhat.parodos.patterndetection.clue.ContentsClueImpl.Builder
builder() - Static method in class com.redhat.parodos.patterndetection.clue.NameClueImpl.Builder
builder() - Static method in class com.redhat.parodos.patterndetection.context.WorkContextDelegate.WorkContextBuilder
Builder() - Constructor for class com.redhat.parodos.patterndetection.clue.AbstractClue.Builder

C

Clue - Interface in com.redhat.parodos.patterndetection.clue: A Clue is a aspect of a file/folder that can be detected.
ClueConfigurationException - Exception in com.redhat.parodos.patterndetection.exceptions: Throw if a @see Clue is being built that can never be detected (ie: missing any of the basic criteria to scan for).
ClueConfigurationException(String) - Constructor for exception com.redhat.parodos.patterndetection.exceptions.ClueConfigurationException
com.redhat.parodos.patterndetection - package com.redhat.parodos.patterndetection
com.redhat.parodos.patterndetection.clue - package com.redhat.parodos.patterndetection.clue
com.redhat.parodos.patterndetection.clue.delegate - package com.redhat.parodos.patterndetection.clue.delegate
com.redhat.parodos.patterndetection.context - package com.redhat.parodos.patterndetection.context
com.redhat.parodos.patterndetection.exceptions - package com.redhat.parodos.patterndetection.exceptions
com.redhat.parodos.patterndetection.pattern - package com.redhat.parodos.patterndetection.pattern
com.redhat.parodos.patterndetection.results - package com.redhat.parodos.patterndetection.results
ContentsClueImpl - Class in com.redhat.parodos.patterndetection.clue: Implementation of a Clue that scans the contents of a file for specific strings.
ContentsClueImpl() - Constructor for class com.redhat.parodos.patterndetection.clue.ContentsClueImpl
ContentsClueImpl.Builder - Class in com.redhat.parodos.patterndetection.clue
continueToRunIfDetected(boolean) - Method in class com.redhat.parodos.patterndetection.clue.AbstractClue.Builder

D

DESIRED_PATTERNS - Enum constant in enum class com.redhat.parodos.patterndetection.context.WorkFlowConstants
detect(WorkContext, Pattern[]) - Static method in class com.redhat.parodos.patterndetection.PatternDetector: Takes a @see WorkContext and a List of @Pattern reference, performs a Scan on code/configuration to determine if the @see Clue references are present to detect one of the desired @Pattern
DETECTED_CLUES - Enum constant in enum class com.redhat.parodos.patterndetection.context.WorkFlowConstants
DETECTED_PATTERNS - Enum constant in enum class com.redhat.parodos.patterndetection.context.WorkFlowConstants
DetectionResults - Class in com.redhat.parodos.patterndetection.results: Wrapper for the results of the Scan: - Detected @see Pattern references (meaning all required @see Clue were discovered) - A list of all the detected @see Clue and the files that triggered the detection.
DetectionResults() - Constructor for class com.redhat.parodos.patterndetection.results.DetectionResults
doesNameMatch(String) - Method in class com.redhat.parodos.patterndetection.clue.delegate.NameMatchingDelegate: Returns a true is a file/folder name matches.

E

execute(WorkContext) - Method in interface com.redhat.parodos.patterndetection.clue.Clue
execute(WorkContext) - Method in class com.redhat.parodos.patterndetection.clue.ContentsClueImpl
execute(WorkContext) - Method in class com.redhat.parodos.patterndetection.clue.NameClueImpl
execute(WorkContext) - Method in class com.redhat.parodos.patterndetection.pattern.BasicPatternImpl: Executes all the Clues in the DESIRED_PATTERNS set in the WorkContext

F

FileContentsDelegate - Class in com.redhat.parodos.patterndetection.clue.delegate: Helper methods for working with Files and their contents.
FileContentsDelegate() - Constructor for class com.redhat.parodos.patterndetection.clue.delegate.FileContentsDelegate
fileContentsToList(File) - Method in class com.redhat.parodos.patterndetection.clue.delegate.FileContentsDelegate: Gets the contents of a file as List of Strings
FILES_TO_SCAN - Enum constant in enum class com.redhat.parodos.patterndetection.context.WorkFlowConstants
FOLDERS_TO_SCAN - Enum constant in enum class com.redhat.parodos.patterndetection.context.WorkFlowConstants

G

getAllAreRequiredClues() - Method in class com.redhat.parodos.patterndetection.pattern.BasicPatternImpl
getAllAreRequiredClues() - Method in interface com.redhat.parodos.patterndetection.pattern.Pattern
getDesiredPatterns(WorkContext) - Method in class com.redhat.parodos.patterndetection.context.WorkContextDelegate
getDetectedClue(WorkContext) - Method in class com.redhat.parodos.patterndetection.context.WorkContextDelegate
getDetectedClue(WorkReport) - Method in class com.redhat.parodos.patterndetection.context.WorkContextDelegate
getDetectedPatterns(WorkContext) - Method in class com.redhat.parodos.patterndetection.context.WorkContextDelegate
getDetectedPatterns(WorkReport) - Method in class com.redhat.parodos.patterndetection.context.WorkContextDelegate
getFilePaths(String) - Method in class com.redhat.parodos.patterndetection.clue.delegate.FileContentsDelegate: Provides a list of Files in a base directory
getFilesToScan(WorkContext) - Method in class com.redhat.parodos.patterndetection.context.WorkContextDelegate
getFolderPaths(String) - Method in class com.redhat.parodos.patterndetection.clue.delegate.FileContentsDelegate: Provides a list of Folders (and Sub Folders) under a base directory
getFoldersToScan(WorkContext) - Method in class com.redhat.parodos.patterndetection.context.WorkContextDelegate
getNameMatchingDelegate() - Method in class com.redhat.parodos.patterndetection.clue.AbstractClue.Builder
getOnlyOneIsRequiredClues() - Method in class com.redhat.parodos.patterndetection.pattern.BasicPatternImpl
getOnlyOneIsRequiredClues() - Method in interface com.redhat.parodos.patterndetection.pattern.Pattern
getPaths(File, String, List<String>) - Method in class com.redhat.parodos.patterndetection.clue.delegate.FileContentsDelegate: A recursive method that updates the passed in List of strings to contains the paths of each file/folder found under the directory
getProperties() - Method in class com.redhat.parodos.patterndetection.pattern.BasicPatternImpl
getThreadPoolExecutor() - Static method in class com.redhat.parodos.patterndetection.ScanningThreadPool

I

ignoreFileNamePattern(String) - Method in class com.redhat.parodos.patterndetection.clue.delegate.NameMatchingDelegate.Builder.NameMatchingDelegateBuilder
ignoreFileNamePatternString(String) - Method in class com.redhat.parodos.patterndetection.clue.AbstractClue.Builder
isFolder(boolean) - Method in class com.redhat.parodos.patterndetection.clue.delegate.NameMatchingDelegate.Builder.NameMatchingDelegateBuilder
isThisATargetFileExtension(File) - Method in class com.redhat.parodos.patterndetection.clue.delegate.NameMatchingDelegate: Determines if a Target File Extension is a match.
isThisClueDetected(Clue, WorkContext) - Method in class com.redhat.parodos.patterndetection.context.WorkContextDelegate: Checks if a specific Clue is detected
isThisClueDetected(Clue, WorkReport) - Method in class com.redhat.parodos.patterndetection.context.WorkContextDelegate: Checks if a specific Clue is detected
isThisPatternDetected(Pattern, WorkReport) - Method in class com.redhat.parodos.patterndetection.context.WorkContextDelegate

M

markClueAsDetected(Clue, File, WorkContext) - Method in class com.redhat.parodos.patterndetection.context.WorkContextDelegate: Updates the WorkContext DETECTED_CLUE collection with this clue

N

name(String) - Method in class com.redhat.parodos.patterndetection.clue.AbstractClue.Builder
NameClueImpl - Class in com.redhat.parodos.patterndetection.clue: Implementation of a Clue that scans the names of Files/Folder for text patterns.
NameClueImpl() - Constructor for class com.redhat.parodos.patterndetection.clue.NameClueImpl
NameClueImpl.Builder - Class in com.redhat.parodos.patterndetection.clue
NameMatchingDelegate - Class in com.redhat.parodos.patterndetection.clue.delegate: Wraps the logic around file/folder name matching
NameMatchingDelegate.Builder - Class in com.redhat.parodos.patterndetection.clue.delegate
NameMatchingDelegate.Builder.NameMatchingDelegateBuilder - Class in com.redhat.parodos.patterndetection.clue.delegate

P

Pattern - Interface in com.redhat.parodos.patterndetection.pattern: Pattern is what the Scan is looking to Detect.
PatternDetectionConfigurationException - Exception in com.redhat.parodos.patterndetection.exceptions: Thrown for any issue related to the parameters passed into the WorkContext to start the scan
PatternDetectionConfigurationException(String) - Constructor for exception com.redhat.parodos.patterndetection.exceptions.PatternDetectionConfigurationException
PatternDetectionRuntimeException - Exception in com.redhat.parodos.patterndetection.exceptions: A catch-all thrown when issues occur during the execution of scans in the WorkFlow
PatternDetectionRuntimeException(String) - Constructor for exception com.redhat.parodos.patterndetection.exceptions.PatternDetectionRuntimeException
PatternDetector - Class in com.redhat.parodos.patterndetection: Main entry point to the library
processResultsAfterScan(WorkContext) - Method in class com.redhat.parodos.patterndetection.context.WorkContextDelegate: This checks all the DESIRED_PATTERNS and compares them to the detected CLUE(S) to see if any of the DESIRED_PATTERNS could become DETECTED_PATTERNS

S

ScanningThreadPool - Class in com.redhat.parodos.patterndetection: Provides access to the ThreadPool executor for all Scans to share.
setProperties(WorkFlowPropertiesMetadata) - Method in class com.redhat.parodos.patterndetection.pattern.BasicPatternImpl
shouldProcessFile(File) - Method in class com.redhat.parodos.patterndetection.clue.delegate.NameMatchingDelegate: Checks if a File is a target file for processing by the Clue.
START_DIRECTORY - Enum constant in enum class com.redhat.parodos.patterndetection.context.WorkFlowConstants
START_FILE - Enum constant in enum class com.redhat.parodos.patterndetection.context.WorkFlowConstants
startDirectory(String) - Method in class com.redhat.parodos.patterndetection.context.WorkContextDelegate.WorkContextBuilder

T

targetContentPatternString(String) - Method in class com.redhat.parodos.patterndetection.clue.ContentsClueImpl.Builder
targetFileExtensionPattern(String) - Method in class com.redhat.parodos.patterndetection.clue.delegate.NameMatchingDelegate.Builder.NameMatchingDelegateBuilder
targetFileExtensionPatternString(String) - Method in class com.redhat.parodos.patterndetection.clue.AbstractClue.Builder
targetFileNamePattern(String) - Method in class com.redhat.parodos.patterndetection.clue.delegate.NameMatchingDelegate.Builder.NameMatchingDelegateBuilder
targetFileNamePatternString(String) - Method in class com.redhat.parodos.patterndetection.clue.AbstractClue.Builder
targetFileNamePatternString(String) - Method in class com.redhat.parodos.patterndetection.clue.NameClueImpl.Builder

V

validateAndIntializeContext(WorkContext) - Method in class com.redhat.parodos.patterndetection.context.WorkContextDelegate: Checks if the WorkContext has everything to perform the Detection: - START_DIRECTORY : the root location to begin processing the files - START_FILE : the root java.util.File to begin processing the files
valueOf(String) - Static method in enum class com.redhat.parodos.patterndetection.context.WorkFlowConstants: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.redhat.parodos.patterndetection.context.WorkFlowConstants: Returns an array containing the constants of this enum class, in the order they are declared.

W

WorkContextDelegate - Class in com.redhat.parodos.patterndetection.context: Contains helper methods for working with the data in the WorkContext.
WorkContextDelegate() - Constructor for class com.redhat.parodos.patterndetection.context.WorkContextDelegate
WorkContextDelegate.WorkContextBuilder - Class in com.redhat.parodos.patterndetection.context
WorkFlowConstants - Enum Class in com.redhat.parodos.patterndetection.context: These are used to put things in the @see WorkContext - DESIRED_PATTERNS - Patterns we are looking for - DETECTED_PATTERNS - As Patterns are found during scanning, they are stored in the WorkContext using this key - START_DIRECTORY - Where to start scanning - FILES_TO_SCAN - The files are folders contained in the START_DIRECTORY - FOLDERS_TO_SCAN - All the folders contained in the START_DIRECTORY location These are used to both PUT and GET from Context

A B C D E F G I M N P S T V W
All Classes and Interfaces|All Packages|Serialized Form