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.
Linear Supertypes
Known Subclasses
Type Hierarchy
Ordering
- Alphabetic
- By Inheritance
Inherited
- PathBuilder
- WalkBuilder
- Growable
- Builder
- Growable
- Clearable
- AnyRef
- Any
Implicitly
- by ChainingOps
- by EdgeAssoc
- by anyToNode
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- Protected
Abstract Value Members
- abstract def add(edge: GraphTraversal.EdgeT): Boolean
Tries to add
edgeto the tail of the path/walk.Tries to add
edgeto the tail of the path/walk.- returns
Whether the addition was successful.
- Definition Classes
- WalkBuilder
- abstract def add(node: NodeT): Boolean
Tries to add
nodeto the tail of the path/walk.Tries to add
nodeto the tail of the path/walk.- returns
Whether the addition was successful.
- Definition Classes
- WalkBuilder
- abstract def clear(): Unit
- Definition Classes
- Builder → Clearable
- abstract def result(): Path
- Definition Classes
- Builder
- abstract def start: NodeT
The node this walk starts at.
The node this walk starts at.
- Definition Classes
- WalkBuilder
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- 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
- final def ++=(xs: scala.collection.IterableOnce[GraphTraversal.InnerElem]): PathBuilder.this.type
- Definition Classes
- Growable
- Annotations
- @inline()
- final def +=(edge: GraphTraversal.EdgeT): PathBuilder.this.type
Tries to add
edgeto the tail of the path/walk.Tries to add
edgeto the tail of the path/walk.- Definition Classes
- WalkBuilder
- Annotations
- @inline()
- final def +=(node: NodeT): PathBuilder.this.type
Tries to add
nodeto the tail of the path/walk.Tries to add
nodeto the tail of the path/walk.- Definition Classes
- WalkBuilder
- Annotations
- @inline()
- final def +=(elem: GraphTraversal.InnerElem): PathBuilder.this.type
- Definition Classes
- Growable
- Annotations
- @inline()
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def add(elem: GraphTraversal.InnerElem): Boolean
Tries to add
elemto the tail of the path/walk.Tries to add
elemto the tail of the path/walk.- returns
Whether the addition was successful.
- Definition Classes
- WalkBuilder
- Annotations
- @inline()
- def addAll(xs: scala.collection.IterableOnce[GraphTraversal.InnerElem]): PathBuilder.this.type
- Definition Classes
- Growable
- def addOne(elem: GraphTraversal.InnerElem): PathBuilder.this.type
Tries to add
elemto the tail of the path/walk.Tries to add
elemto the tail of the path/walk.- Definition Classes
- WalkBuilder → Growable
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- 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
- 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
- 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
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def isDefined: Boolean
- Implicit
- This member is added by an implicit conversion from PathBuilder toOuterNode[PathBuilder] performed by method anyToNode in scalax.collection.GraphPredef.
- Definition Classes
- Param
- final def isEdge: Boolean
- Implicit
- This member is added by an implicit conversion from PathBuilder toOuterNode[PathBuilder] performed by method anyToNode in scalax.collection.GraphPredef.
- Definition Classes
- Param
- def isIn: Boolean
- Implicit
- This member is added by an implicit conversion from PathBuilder toOuterNode[PathBuilder] performed by method anyToNode in scalax.collection.GraphPredef.
- Definition Classes
- InParam → Param
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isNode: Boolean
- Implicit
- This member is added by an implicit conversion from PathBuilder toOuterNode[PathBuilder] performed by method anyToNode in scalax.collection.GraphPredef.
- Definition Classes
- NodeParam
- final def isOut: Boolean
- Implicit
- This member is added by an implicit conversion from PathBuilder toOuterNode[PathBuilder] performed by method anyToNode in scalax.collection.GraphPredef.
- Definition Classes
- Param
- def knownSize: Int
- Definition Classes
- Growable
- def mapResult[NewTo](f: (Path) => NewTo): Builder[GraphTraversal.InnerElem, NewTo]
- Definition Classes
- Builder
- val n1: PathBuilder
- Implicit
- This member is added by an implicit conversion from PathBuilder toEdgeAssoc[PathBuilder] performed by method EdgeAssoc in scalax.collection.GraphPredef.
- Definition Classes
- EdgeAssoc
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def pipe[B](f: (PathBuilder) => B): B
- Implicit
- This member is added by an implicit conversion from PathBuilder toChainingOps[PathBuilder] performed by method ChainingOps in scalax.collection.
- Definition Classes
- ChainingOps
- def productElementNames: Iterator[String]
- Implicit
- This member is added by an implicit conversion from PathBuilder toOuterNode[PathBuilder] performed by method anyToNode in scalax.collection.GraphPredef.
- Definition Classes
- Product
- val self: PathBuilder
- Implicit
- This member is added by an implicit conversion from PathBuilder toChainingOps[PathBuilder] performed by method ChainingOps in scalax.collection.
- Definition Classes
- ChainingOps
- final def sizeHint(coll: scala.collection.IterableOnce[_], delta: Int): Unit
- Definition Classes
- Builder
- def sizeHint(size: Int): Unit
- Definition Classes
- Builder
- final def sizeHintBounded(size: Int, boundingColl: Iterable[_]): Unit
- Definition Classes
- Builder
- def stringPrefix: String
- Implicit
- This member is added by an implicit conversion from PathBuilder toOuterNode[PathBuilder] performed by method anyToNode in scalax.collection.GraphPredef.
- Definition Classes
- NodeParam
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def tap[U](f: (PathBuilder) => U): PathBuilder
- Implicit
- This member is added by an implicit conversion from PathBuilder toChainingOps[PathBuilder] performed by method ChainingOps in scalax.collection.
- Definition Classes
- ChainingOps
- def toString(): String
- Definition Classes
- AnyRef → Any
- val value: PathBuilder
- Implicit
- This member is added by an implicit conversion from PathBuilder toOuterNode[PathBuilder] performed by method anyToNode in scalax.collection.GraphPredef.
- Definition Classes
- OuterNode → NodeParam
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def ~[N >: N1](n2: N): UnDiEdge[N]
- Implicit
- This member is added by an implicit conversion from PathBuilder toEdgeAssoc[PathBuilder] performed by method EdgeAssoc in scalax.collection.GraphPredef.
- Definition Classes
- EdgeAssoc
- Annotations
- @inline()
- def ~>[N >: N1](n2: N): DiEdge[N]
- Implicit
- This member is added by an implicit conversion from PathBuilder toEdgeAssoc[PathBuilder] performed by method EdgeAssoc in scalax.collection.GraphPredef.
- Definition Classes
- EdgeAssoc
- Annotations
- @inline()
Shadowed Implicit Value Members
- def toString(): String
- Implicit
- This member is added by an implicit conversion from PathBuilder toOuterNode[PathBuilder] performed by method anyToNode in scalax.collection.GraphPredef.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(pathBuilder: OuterNode[PathBuilder]).toString()
- Definition Classes
- NodeParam → AnyRef → Any
Deprecated Value Members
- 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
++=akaaddAllinstead of varargs+=; infix operations with an operand of multiple args will be deprecated
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
- 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 ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- 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.
Welcome to the Graph for Scala API reference. Some suggested navigation entry points:
Graphmutable.Graphand its inner nodes.GraphEdgeobjectedgepackageGraphPredefobject andImplicitsobject.GraphTraversalandTraverserInnerNode.RandomGraph.GraphGen.