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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val ColumnNames: Array[String]
  5. val ColumnNamesVerbose: Array[String]
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def findStepDocs(traversal: Class[_]): Iterable[StepDoc]
    Attributes
    protected
  11. def forElementSpecificSteps(elementClass: Class[_], verbose: Boolean): String
  12. lazy val forTraversalSources: String
  13. lazy val genericNodeStepDocs: Iterable[StepDoc]
  14. lazy val genericStepDocs: Iterable[StepDoc]
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def registerAdditionalSearchPackage(packageName: String): TraversalHelp.this.type

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

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

  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped