flatgraph-help
API
Generated with
flatgraph-help/flatgraph.help/TraversalHelp

TraversalHelp

flatgraph.help.TraversalHelp
See theTraversalHelp companion object
class TraversalHelp(packageNamesToSearch: 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 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
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def forElementSpecificSteps(elementClass: Class[_], verbose: Boolean)(implicit availableWidthProvider: AvailableWidthProvider): String
def forTraversalSources(verbose: Boolean)(implicit availableWidthProvider: AvailableWidthProvider): String

Concrete fields

lazy val genericStepDocs: Iterable[StepDoc]
lazy val nodeStepDocs: Iterable[StepDoc]
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. node.Method).

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

Attributes

Generated with