overflowdb.traversal.help

Type members

Classlikes

object DocFinder

defines where we should search for @Traversal/@TraversalSource/@Doc annotations

defines where we should search for @Traversal/@TraversalSource/@Doc annotations

Companion:
object
Companion:
class
case class Table(columnNames: Iterable[String], rows: Iterable[Iterable[String]])
class TraversalHelp(searchPackages: DocSearchPackages)

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

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

Companion:
object
Companion:
class