overflowdb.traversal.help
Members list
Type members
Classlikes
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
DocFinder.type
defines where we should search for @Traversal/@TraversalSource/@Doc annotations
defines where we should search for @Traversal/@TraversalSource/@Doc annotations
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
DocSearchPackages.type
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Searches classpath for @Traversal|@TraversalSource and @Doc annotations (via reflection). Used for .help step. There are two use cases for this, which require slightly different implementations 1) myDomain.help - for the node starter steps 2) myDomain.someNodeType.help - for steps that are available a specific node type
Searches classpath for @Traversal|@TraversalSource and @Doc annotations (via reflection). Used for .help step. There are two use cases for this, which require slightly different implementations 1) myDomain.help - for the node starter steps 2) myDomain.someNodeType.help - for steps that are available a specific node type
For use case 2, we also take into account all parent traits of a node type, recursively. I.e. if SomeNodeType has a base type SomeBaseType, and there are steps defined for Traversal[SomeBaseType], we will include those in the results.
Value parameters
- searchPackages:
-
The base packages that we scan for - we're not scanning the entire classpath
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
Attributes
- Companion
- class
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
TraversalHelp.type