Matcher

coldbox.system.aop

Class Matcher

lucee.Component
    coldbox.system.aop.Matcher

Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com --- I match class and method names to data in this matcher

Class Attributes:

synchronized : false

accessors : true

persistent : false

Property Summary
type	property	default	serializable	required
`any`	and And operator. access = public returntype = any		`true`	`false`
`any`	annotation Matching annotations. access = public returntype = any		`true`	`false`
`any`	annotationValue Matching annotation value. access = public returntype = any		`true`	`false`
`any`	any Any matcher. access = public returntype = any		`true`	`false`
`any`	instanceOf Matching instances. access = public returntype = any		`true`	`false`
`any`	mappings Matching mapping names. access = public returntype = any		`true`	`false`
`any`	methods Mathching method names. access = public returntype = any		`true`	`false`
`any`	or OR operator. access = public returntype = any		`true`	`false`
`any`	regex Matchin regex. access = public returntype = any		`true`	`false`
`any`	returns Matching returns. access = public returntype = any		`true`	`false`

Constructor Summary
init() Constructor.

Method Summary
`any`	andMatch(any<Matcher> 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.
`string`	getAnd()
`string`	getAnnotation()
`string`	getAnnotationValue()
`string`	getAny()
`string`	getInstanceOf()
`string`	getMappings()
`any`	getMemento() Get the matcher memento.
`string`	getMethods()
`string`	getOr()
`string`	getRegex()
`string`	getReturns()
`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<Mapping> mapping) Matches a class to this matcher according to its criteria.
`private boolean`	matchClassRules(any target, any<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> 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.
`any`	setAnd(any and)
`any`	setAnnotation(any annotation)
`any`	setAnnotationValue(any annotationValue)
`any`	setAny(any any)
`any`	setInstanceOf(any instanceOf)
`any`	setMappings(any mappings)
`any`	setMethods(any methods)
`any`	setOr(any or)
`any`	setRegex(any regex)
`any`	setReturns(any returns)

Methods inherited from class `lucee.Component`
None

Constructor Detail

init

public init()

Constructor

Property Detail

and

property any and

And operator

Attributes:: access - public; required - false; returntype - any; serializable - true

annotation

property any annotation

Matching annotations

Attributes:: access - public; required - false; returntype - any; serializable - true

annotationValue

property any annotationValue

Matching annotation value

Attributes:: access - public; required - false; returntype - any; serializable - true

any

property any any

Any matcher

Attributes:: access - public; required - false; returntype - any; serializable - true

instanceOf

property any instanceOf

Matching instances

Attributes:: access - public; required - false; returntype - any; serializable - true

mappings

property any mappings

Matching mapping names

Attributes:: access - public; required - false; returntype - any; serializable - true

methods

property any methods

Mathching method names

Attributes:: access - public; required - false; returntype - any; serializable - true

or

property any or

OR operator

Attributes:: access - public; required - false; returntype - any; serializable - true

regex

property any regex

Matchin regex

Attributes:: access - public; required - false; returntype - any; serializable - true

returns

property any returns

Matching returns

Attributes:: access - public; required - false; returntype - any; serializable - true

Method Detail

andMatch

public any andMatch(any<Matcher> 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

getAnd

public string getAnd()

getAnnotation

public string getAnnotation()

getAnnotationValue

public string getAnnotationValue()

getAny

public string getAny()

getInstanceOf

public string getInstanceOf()

getMappings

public string getMappings()

getMemento

public any getMemento()

Get the matcher memento

getMethods

public string getMethods()

getOr

public string getOr()

getRegex

public string getRegex()

getReturns

public string getReturns()

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<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

matchClassRules

private boolean matchClassRules(any target, any<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

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> matcher)

OR this matcher with another matcher

Parameters:: matcher - The matcher to AND 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

setAnd

public any setAnd(any and)

Parameters:: and

setAnnotation

public any setAnnotation(any annotation)

Parameters:: annotation

setAnnotationValue

public any setAnnotationValue(any annotationValue)

Parameters:: annotationValue

setAny

public any setAny(any any)

Parameters:: any

setInstanceOf

public any setInstanceOf(any instanceOf)

Parameters:: instanceOf

setMappings

public any setMappings(any mappings)

Parameters:: mappings

setMethods

public any setMethods(any methods)

Parameters:: methods

setOr

public any setOr(any or)

Parameters:: or

setRegex

public any setRegex(any regex)

Parameters:: regex

setReturns

public any setReturns(any returns)

Parameters:: returns