Packages

class TraversalHelp extends AnyRef

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.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TraversalHelp
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TraversalHelp(searchPackages: DocSearchPackages)

Value Members

  1. def forElementSpecificSteps(elementClass: Class[_], verbose: Boolean): String
  2. lazy val forTraversalSources: String
  3. lazy val genericNodeStepDocs: Iterable[StepDoc]
  4. lazy val genericStepDocs: Iterable[StepDoc]
  5. lazy val stepDocsByElementType: Map[Class[_], List[StepDoc]]

    Scans the entire classpath for classes annotated with @TraversalExt (using java reflection), to then extract the @Doc annotations for all steps, and group them by the elementType (e.g.

    Scans the entire classpath for classes annotated with @TraversalExt (using java reflection), to then extract the @Doc annotations for all steps, and group them by the elementType (e.g. node.Method).