Packages

class EdgeDescriptor[N, E <: AnyEdge[N]] extends EdgeDescriptorBase[N, E]

Determines how to extract data of non-labeled edges from a JValue and how to decompose such an edge to a JValue.

Instances of this class must be passed as a constructor argument to a scalax.collection.io.json.descriptor.Descriptor either directly or indirectly by utilizing a predefined edge descriptor.

Linear Supertypes
EdgeDescriptorBase[N, E], GenEdgeDescriptor[N], TypeId, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EdgeDescriptor
  2. EdgeDescriptorBase
  3. GenEdgeDescriptor
  4. TypeId
  5. AnyRef
  6. 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 EdgeDescriptor(edgeFactory: (N, N) => E, customSerializer: Option[Serializer[_ <: EdgeParameters]] = None, extraClasses: List[Class[_]] = Nil, typeId: String = Defaults.defaultId)(implicit classTag: ClassTag[E])

    edgeFactory

    factory method to create DiEdge or UnDiEdge.

    customSerializer

    Some list-json custom serializer or None.

    extraClasses

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

    typeId

    denotes the edge type in a JSON text.

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 EdgeDescriptor[N, E] toany2stringadd[EdgeDescriptor[N, E]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (EdgeDescriptor[N, E], B)
    Implicit
    This member is added by an implicit conversion from EdgeDescriptor[N, E] toArrowAssoc[EdgeDescriptor[N, E]] 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. val classTag: ClassTag[_]
    Definition Classes
    GenEdgeDescriptor
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. val customSerializer: Option[Serializer[_ <: Parameters]]
    Definition Classes
    EdgeDescriptorBase
  10. final def decompose(edge: E)(implicit descriptor: Descriptor[N]): JValue
    Definition Classes
    EdgeDescriptorBase
  11. val edgeFactory: (N, N) => E
  12. def ensuring(cond: (EdgeDescriptor[N, E]) => Boolean, msg: => Any): EdgeDescriptor[N, E]
    Implicit
    This member is added by an implicit conversion from EdgeDescriptor[N, E] toEnsuring[EdgeDescriptor[N, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (EdgeDescriptor[N, E]) => Boolean): EdgeDescriptor[N, E]
    Implicit
    This member is added by an implicit conversion from EdgeDescriptor[N, E] toEnsuring[EdgeDescriptor[N, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: => Any): EdgeDescriptor[N, E]
    Implicit
    This member is added by an implicit conversion from EdgeDescriptor[N, E] toEnsuring[EdgeDescriptor[N, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): EdgeDescriptor[N, E]
    Implicit
    This member is added by an implicit conversion from EdgeDescriptor[N, E] toEnsuring[EdgeDescriptor[N, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  18. val extraClasses: List[Class[_]]
    Definition Classes
    EdgeDescriptorBase
  19. def extract(jsonEdge: JValue): EdgeParameters
    Definition Classes
    EdgeDescriptor → EdgeDescriptorBase
  20. implicit val formats: Formats
    Attributes
    protected
    Definition Classes
    EdgeDescriptorBase
  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. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. def nodeIds(ends: OneOrMore[N], descriptor: Descriptor[N]): OneOrMoreNodeIds
    Attributes
    protected
    Definition Classes
    EdgeDescriptorBase
  26. def nodeIds(edge: E, descriptor: Descriptor[N]): SeveralNodeIds
    Attributes
    protected
    Definition Classes
    EdgeDescriptorBase
  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 synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  30. def toParameters(edge: E)(implicit descriptor: Descriptor[N]): EdgeParameters
    Attributes
    protected
    Definition Classes
    EdgeDescriptor → EdgeDescriptorBase
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. val typeId: String
    Definition Classes
    GenEdgeDescriptor → TypeId
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  35. 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 EdgeDescriptor[N, E] toStringFormat[EdgeDescriptor[N, E]] 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): (EdgeDescriptor[N, E], B)
    Implicit
    This member is added by an implicit conversion from EdgeDescriptor[N, E] toArrowAssoc[EdgeDescriptor[N, E]] 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 EdgeDescriptorBase[N, E]

Inherited from GenEdgeDescriptor[N]

Inherited from TypeId

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromEdgeDescriptor[N, E] to any2stringadd[EdgeDescriptor[N, E]]

Inherited by implicit conversion StringFormat fromEdgeDescriptor[N, E] to StringFormat[EdgeDescriptor[N, E]]

Inherited by implicit conversion Ensuring fromEdgeDescriptor[N, E] to Ensuring[EdgeDescriptor[N, E]]

Inherited by implicit conversion ArrowAssoc fromEdgeDescriptor[N, E] to ArrowAssoc[EdgeDescriptor[N, E]]

Ungrouped