Packages

final class Descriptor[N] extends AnyRef

Top level descriptor to be passed to Graph/JSON conversion methods, in particular to fromJson and toJson.

N

the type of graph nodes.

Exceptions thrown

`IllegalArgumentException` if any of the descriptor maps is empty.

Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Descriptor
  2. AnyRef
  3. 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

Instance Constructors

  1. new Descriptor(nodeDescriptors: Map[String, NodeDescriptor[N]], edgeDescriptors: Map[String, GenEdgeDescriptor[N]], sectionKeys: SectionKeys = SectionKeys.default)

    nodeDescriptors

    non-empty Map of type Ids to NodeDscriptors.

    edgeDescriptors

    non-empty Map of type Ids to EdgeDscriptors.

    sectionKeys

    the JSON keys to denote node and edge sections in the JSON text.

    Exceptions thrown

    `IllegalArgumentException` if any of the descriptor maps is empty.

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 Descriptor[N] toany2stringadd[Descriptor[N]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Descriptor[N], B)
    Implicit
    This member is added by an implicit conversion from Descriptor[N] toArrowAssoc[Descriptor[N]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  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. def edgeDescriptor(clazz: Class[_]): GenEdgeDescriptor[N]
  9. def edgeDescriptor(typeId: String): Option[GenEdgeDescriptor[N]]
  10. def ensuring(cond: (Descriptor[N]) => Boolean, msg: => Any): Descriptor[N]
    Implicit
    This member is added by an implicit conversion from Descriptor[N] toEnsuring[Descriptor[N]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (Descriptor[N]) => Boolean): Descriptor[N]
    Implicit
    This member is added by an implicit conversion from Descriptor[N] toEnsuring[Descriptor[N]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): Descriptor[N]
    Implicit
    This member is added by an implicit conversion from Descriptor[N] toEnsuring[Descriptor[N]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): Descriptor[N]
    Implicit
    This member is added by an implicit conversion from Descriptor[N] toEnsuring[Descriptor[N]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. val hasSingleEdgeDescriptor: Boolean
  18. val hasSingleNodeDescriptor: Boolean
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def nodeDescriptor(node: N): NodeDescriptor[N]
  23. def nodeDescriptor(typeId: String): Option[NodeDescriptor[N]]
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. val sectionKeys: SectionKeys
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  31. 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
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Descriptor[N] toStringFormat[Descriptor[N]] 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.

  3. def →[B](y: B): (Descriptor[N], B)
    Implicit
    This member is added by an implicit conversion from Descriptor[N] toArrowAssoc[Descriptor[N]] 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 AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromDescriptor[N] to any2stringadd[Descriptor[N]]

Inherited by implicit conversion StringFormat fromDescriptor[N] to StringFormat[Descriptor[N]]

Inherited by implicit conversion Ensuring fromDescriptor[N] to Ensuring[Descriptor[N]]

Inherited by implicit conversion ArrowAssoc fromDescriptor[N] to ArrowAssoc[Descriptor[N]]

Ungrouped