| Functions |
Name |
Owner |
Returns |
Description |
| findIn |
Global |
number |
Locates member objects and methods of the object denoted by the
Obj parameter, and according to any search terms, and within any
depth-constraint provided. Optionally, will call a user-defined
function for each member located.
|
|
| onFound |
* |
boolean |
If supplied to findIn, is called for each member found that
conforms to the search terms supplied to that function (if
any), and that resides within the depth-constraint passed to that
function (if any).
The call-back function is free to do whatever it wishes,
including calling findIn.
|
|
| findIn_DbC |
Global |
undefined |
Applies an AspectJS method-call prefix to findIn that checks the
parameters passed to that function,
and which throws an exception when bad or missing parameters are
detected.
|
|
|
| Signatures | Returns | Owner | Function | Arguments... |
| boolean | Global | findIn | ( | Obj | [, | SearchTerms | [, | onFound | [, | DepthMax | [, CallPoint]]]]) |
| boolean | * | onFound | ([ | Obj | [, | Member | [, | Depth | | | [, CallPoint]]]]) |
| undefined | * | findIn_DbC | ( | findInOwner | , | findInName | , | AJS | | | [, CallPoint]) |
|
| Arguments | Name | Type | Denotes | Optional | Default Value | Can be Null | Can be < 1 |
| Obj | object | Object to search | No | - | No | - |
| SearchTerms | string | Members(s) to search for | Yes | "." | Yes | - |
| onFound | function | Call-back for when member found | Yes | Empty function | Yes | - |
| DepthMax | number | Depth to which to search within Object | Yes | Infinity | - | No |
| Depth | number | Depth at which Member was found | Yes | - | - | No |
| Member | string | A member found by findIn | Yes | - | - | - |
| findInOwner | object | Object that owns findIn | No | - | No | - |
| findInName | string | Name of findIn function | No | - | No | - |
| AJS | AJS object | The AspectJS AJS-object | No | - | No | - |
| CallPoint | string | User-defined profiling/debugging data | Yes | undefined | Yes | Yes |
|
| Returns | Function | Type | Denotes | Caller Should Retain | Can be Calling-Object | Can be Null | Can be < 1 | Is false when... |
| findIn | number | Number of conforming members found | User Decides | - | - | No | - |
| onFound | boolean | To continue search or not | - | - | - | - | Search should cease |
| findIn_DbC | undefined | - | - | - | - | - | - |
|
| Exceptions |
Function |
Throw(s) Error Object if... |
Provisos |
| findIn |
Obj is undefined
Obj is null
Obj is not an Object
SearchTerms is not a string
OnFound does not refer to a function
DepthMax is non-numeric
DepthMax is negative
|
Applies only if you
import and call
findIn_DbC
into and within
your application.
|
| onFound |
User Decides
|
| findIn_DbC |
findInOwner is undefined
findInOwner is null
findInOwner does not refer to an object
findInName is undefined
findInName is null
findInName is not a string
AJS is undefined
AJS does not refer to an object
Object referred to by AJS argument has no getVersion method
AJS argument does not refer to version 1.1 of the AJS object
|
Applies only if you
import and call
findIn_DbC
into and within
your application.
|
