Packages

trait PathBuilder extends WalkBuilder with Builder[InnerElem, Path]

A Builder for valid paths in this graph.

Nodes and edges may be added either alternating or node by node respectively edge by edge. Either way, the builder ensures that the added elements build a valid path.

A node addition fails if either the node to be added is already contained or the node is not a direct successor of the previously added node or of the target node of the previously added edge. An edge addition fails if either the edge to be added is is already contained or the edge is not an outgoing edge from the previously added node or of the target node of the previously added edge.

It is recommended using add instead of += to track failed additions.

Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PathBuilder
  2. WalkBuilder
  3. Builder
  4. Growable
  5. Clearable
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def add(edge: GraphTraversal.EdgeT): Boolean

    Tries to add edge to the tail of the path/walk.

    Tries to add edge to the tail of the path/walk.

    returns

    Whether the addition was successful.

    Definition Classes
    WalkBuilder
  2. abstract def add(node: NodeT): Boolean

    Tries to add node to the tail of the path/walk.

    Tries to add node to the tail of the path/walk.

    returns

    Whether the addition was successful.

    Definition Classes
    WalkBuilder
  3. abstract def clear(): Unit
    Definition Classes
    Builder → Clearable
  4. abstract def result(): Path
    Definition Classes
    Builder
  5. abstract def start: NodeT

    The node this walk starts at.

    The node this walk starts at.

    Definition Classes
    WalkBuilder

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from PathBuilder toany2stringadd[PathBuilder] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. final def ++=(xs: IterableOnce[GraphTraversal.InnerElem]): PathBuilder.this.type
    Definition Classes
    Growable
    Annotations
    @inline()
  5. final def +=(edge: GraphTraversal.EdgeT): PathBuilder.this.type

    Tries to add edge to the tail of the path/walk.

    Tries to add edge to the tail of the path/walk.

    Definition Classes
    WalkBuilder
    Annotations
    @inline()
  6. final def +=(node: NodeT): PathBuilder.this.type

    Tries to add node to the tail of the path/walk.

    Tries to add node to the tail of the path/walk.

    Definition Classes
    WalkBuilder
    Annotations
    @inline()
  7. final def +=(elem: GraphTraversal.InnerElem): PathBuilder.this.type
    Definition Classes
    Growable
    Annotations
    @inline()
  8. def ->[B](y: B): (PathBuilder, B)
    Implicit
    This member is added by an implicit conversion from PathBuilder toArrowAssoc[PathBuilder] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  9. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. final def add(elem: GraphTraversal.InnerElem): Boolean

    Tries to add elem to the tail of the path/walk.

    Tries to add elem to the tail of the path/walk.

    returns

    Whether the addition was successful.

    Definition Classes
    WalkBuilder
  11. def addAll(xs: IterableOnce[GraphTraversal.InnerElem]): PathBuilder.this.type
    Definition Classes
    Growable
  12. def addOne(elem: GraphTraversal.InnerElem): PathBuilder.this.type

    Tries to add elem to the tail of the path/walk.

    Tries to add elem to the tail of the path/walk.

    Definition Classes
    WalkBuilder → Growable
  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  15. def ensuring(cond: (PathBuilder) => Boolean, msg: => Any): PathBuilder
    Implicit
    This member is added by an implicit conversion from PathBuilder toEnsuring[PathBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (PathBuilder) => Boolean): PathBuilder
    Implicit
    This member is added by an implicit conversion from PathBuilder toEnsuring[PathBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean, msg: => Any): PathBuilder
    Implicit
    This member is added by an implicit conversion from PathBuilder toEnsuring[PathBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): PathBuilder
    Implicit
    This member is added by an implicit conversion from PathBuilder toEnsuring[PathBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. def knownSize: Int
    Definition Classes
    Growable
  25. def mapResult[NewTo](f: (Path) => NewTo): Builder[GraphTraversal.InnerElem, NewTo]
    Definition Classes
    Builder
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. final def sizeHint(coll: IterableOnce[_], delta: Int): Unit
    Definition Classes
    Builder
  30. def sizeHint(size: Int): Unit
    Definition Classes
    Builder
  31. final def sizeHintBounded(size: Int, boundingColl: Iterable[_]): Unit
    Definition Classes
    Builder
  32. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  33. def toString(): String
    Definition Classes
    AnyRef → Any
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. final def +=(elem1: GraphTraversal.InnerElem, elem2: GraphTraversal.InnerElem, elems: GraphTraversal.InnerElem*): PathBuilder.this.type
    Definition Classes
    Growable
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use ++= aka addAll instead of varargs +=; infix operations with an operand of multiple args will be deprecated

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  3. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from PathBuilder toStringFormat[PathBuilder] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  4. def [B](y: B): (PathBuilder, B)
    Implicit
    This member is added by an implicit conversion from PathBuilder toArrowAssoc[PathBuilder] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from WalkBuilder

Inherited from Clearable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromPathBuilder to any2stringadd[PathBuilder]

Inherited by implicit conversion StringFormat fromPathBuilder to StringFormat[PathBuilder]

Inherited by implicit conversion Ensuring fromPathBuilder to Ensuring[PathBuilder]

Inherited by implicit conversion ArrowAssoc fromPathBuilder to ArrowAssoc[PathBuilder]

Ungrouped