Packages

class TraversalHelp extends AnyRef

domainBasePackage: The base package that we scan for @Traversal annotations. You can register additional packages via registerAdditionalSearchPackage.

Note that this restricts us to only find @Doc annotations in classes in that namespace and it's children. If you specify the root package or leave this empty, the scan takes considerable amount of time (depending on your classpath).

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(domainBasePackage: String)

Value Members

  1. val ColumnNames: Array[String]
  2. val ColumnNamesVerbose: Array[String]
  3. def forElementSpecificSteps(elementClass: Class[_], verbose: Boolean): String
  4. lazy val forTraversalSources: String
  5. lazy val genericNodeStepDocs: Iterable[StepDoc]
  6. lazy val genericStepDocs: Iterable[StepDoc]
  7. def registerAdditionalSearchPackage(packageName: String): TraversalHelp.this.type

    register an additional package that should be searched for @Doc annotations

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