Packages

abstract class NodeDescriptor[+N] extends TypeId

Determines how to extract node data from a JValue and how to decompose the node to a JValue.

N

type of nodes described with this descriptor which either the same type or a subtype of the node type parameter of the targeted graph.

Linear Supertypes
TypeId, AnyRef, Any
Known Subclasses
StringNodeDescriptor
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NodeDescriptor
  2. TypeId
  3. AnyRef
  4. 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 NodeDescriptor(typeId: String = Defaults.defaultId, customSerializers: Iterable[Serializer[_]] = Nil, extraClasses: List[Class[_]] = Nil, furtherManifests: List[Manifest[_]] = Nil)(implicit nodeManifest: Manifest[N])

    typeId

    denotes the node type in a JSON text; defaults to (default).

    customSerializers

    list of list-json custom serializers to be invoked for node serialization, defaulting to an empty list.

    extraClasses

    list of classes referenced by this node provided they are to be (de)serialized; empty by default.

    furtherManifests

    list of manifests denoting subtypes of N which are to be processed, defaulting to an empty list.

Abstract Value Members

  1. abstract def id[B >: N](node: B): String

    Enables Graph for Scala JSON export/import to handle node references in JSON edge entries.

    Enables Graph for Scala JSON export/import to handle node references in JSON edge entries. Without establishing such references, JSON edge entries would have to contain all node data what would make JSON texts representing graphs explode in length.

    Please exercise great care when designing the id method to return unique keys.

    node

    a node of type N for which its unique id is to be returned. You can safely match node to the actual type argument N.

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 NodeDescriptor[N] toany2stringadd[NodeDescriptor[N]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (NodeDescriptor[N], B)
    Implicit
    This member is added by an implicit conversion from NodeDescriptor[N] toArrowAssoc[NodeDescriptor[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 decompose(node: Any): JValue
  9. def ensuring(cond: (NodeDescriptor[N]) => Boolean, msg: => Any): NodeDescriptor[N]
    Implicit
    This member is added by an implicit conversion from NodeDescriptor[N] toEnsuring[NodeDescriptor[N]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (NodeDescriptor[N]) => Boolean): NodeDescriptor[N]
    Implicit
    This member is added by an implicit conversion from NodeDescriptor[N] toEnsuring[NodeDescriptor[N]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): NodeDescriptor[N]
    Implicit
    This member is added by an implicit conversion from NodeDescriptor[N] toEnsuring[NodeDescriptor[N]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): NodeDescriptor[N]
    Implicit
    This member is added by an implicit conversion from NodeDescriptor[N] toEnsuring[NodeDescriptor[N]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. def extract(jsonNode: JValue): N
  16. implicit val formats: Formats
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. val manifests: Seq[Manifest[_]]
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. val typeId: String
    Definition Classes
    NodeDescriptor → TypeId
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. 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 NodeDescriptor[N] toStringFormat[NodeDescriptor[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): (NodeDescriptor[N], B)
    Implicit
    This member is added by an implicit conversion from NodeDescriptor[N] toArrowAssoc[NodeDescriptor[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 TypeId

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromNodeDescriptor[N] to any2stringadd[NodeDescriptor[N]]

Inherited by implicit conversion StringFormat fromNodeDescriptor[N] to StringFormat[NodeDescriptor[N]]

Inherited by implicit conversion Ensuring fromNodeDescriptor[N] to Ensuring[NodeDescriptor[N]]

Inherited by implicit conversion ArrowAssoc fromNodeDescriptor[N] to ArrowAssoc[NodeDescriptor[N]]

Ungrouped