ColdBox Platform v3.8.0

coldbox.system.aop
Class Matcher

WEB-INF.cftags.component
        extended by coldbox.system.aop.Matcher

public class Matcher
extends WEB-INF.cftags.component

I match class and method names to data in this matcher

Constructor Summary
init()
          Constructor
 
Method Summary
 any andMatch(any matcher)
          AND this matcher with another matcher
 any annotatedWith(any annotation, [any value])
          Matches annotations on components or methods with or without a value
 any any()
          Match against any method name or class path
 any getMemento()
          Get the matcher memento
 any instanceOf(any classPath)
          Matches against a family of components according to the passed classPath
 any mappings(any mappings)
          Match one, list or array of mapping names
 boolean matchClass(any target, any<coldbox.system.ioc.config.Mapping> mapping)
          Matches a class to this matcher according to its criteria
private boolean matchClassRules(any target, any<coldbox.system.ioc.config.Mapping> mapping)
          Go through all the rules in this matcher and match
 boolean matchMethod(any metadata)
          Matches a method to this matcher according to its criteria
private boolean matchMethodRules(any metadata)
          Go through all the rules in this matcher and match
 any methods(any methods)
          A list, one or an array of methods to explicitly match
 any orMatch(any matcher)
          OR this matcher with another matcher
 any regex(any regex)
          Matches a class path or method name to this regular expression
 any reset()
          Reset the matcher memento to defaults
 any returns(any type)
          Match against return types in methods only
 
Methods inherited from class WEB-INF.cftags.component
None
 

Constructor Detail

init

public init()
Constructor

Method Detail

andMatch

public any andMatch(any matcher)
AND this matcher with another matcher

Parameters:
matcher - The matcher to AND this matcher with

annotatedWith

public any annotatedWith(any annotation, [any value])
Matches annotations on components or methods with or without a value

Parameters:
annotation - The annotation to discover
value - The value of the annotation that must match. OPTIONAL

any

public any any()
Match against any method name or class path


getMemento

public any getMemento()
Get the matcher memento


instanceOf

public any instanceOf(any classPath)
Matches against a family of components according to the passed classPath. Class Matching Only.

Parameters:
classPath - The class path to verify instance of

mappings

public any mappings(any mappings)
Match one, list or array of mapping names. Class Matching Only.

Parameters:
mappings - One, list or array of mappings to match

matchClass

public boolean matchClass(any target, any<coldbox.system.ioc.config.Mapping> mapping)
Matches a class to this matcher according to its criteria

Parameters:
target - The target to match against to
mapping - The target mapping to match against to

matchClassRules

private boolean matchClassRules(any target, any<coldbox.system.ioc.config.Mapping> mapping)
Go through all the rules in this matcher and match

Parameters:
target - The target to match against to
mapping - The target mapping to match against to

matchMethod

public boolean matchMethod(any metadata)
Matches a method to this matcher according to its criteria

Parameters:
metadata - The UDF metadata to use for matching

matchMethodRules

private boolean matchMethodRules(any metadata)
Go through all the rules in this matcher and match

Parameters:
metadata - The UDF metadata to use for matching

methods

public any methods(any methods)
A list, one or an array of methods to explicitly match

Parameters:
methods - One, list or array of methods to match

orMatch

public any orMatch(any matcher)
OR this matcher with another matcher

Parameters:
matcher - The matcher to OR this matcher with

regex

public any regex(any regex)
Matches a class path or method name to this regular expression

Parameters:
regex - The regular expression to match against

reset

public any reset()
Reset the matcher memento to defaults


returns

public any returns(any type)
Match against return types in methods only

Parameters:
type - The type of return to match against. Only for method matching

ColdBox Platform v3.8.0