Class

scalax.collection.io.json.descriptor

NodeDescriptor

Related Doc: package descriptor

Permalink

abstract class NodeDescriptor[+N] extends TypeId

Provides information on 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
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
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. All

Instance Constructors

  1. new NodeDescriptor(typeId: String = Defaults.defaultId, customSerializers: Traversable[Serializer[_]] = Nil, extraClasses: List[Class[_]] = Nil, furtherManifests: List[Manifest[_]] = Nil)(implicit nodeManifest: Manifest[N])

    Permalink

    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(node: Any): String

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from NodeDescriptor[N] to any2stringadd[NodeDescriptor[N]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (NodeDescriptor[N], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from NodeDescriptor[N] to ArrowAssoc[NodeDescriptor[N]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def decompose(node: Any): JValue

    Permalink
  9. def ensuring(cond: (NodeDescriptor[N]) ⇒ Boolean, msg: ⇒ Any): NodeDescriptor[N]

    Permalink
    Implicit information
    This member is added by an implicit conversion from NodeDescriptor[N] to Ensuring[NodeDescriptor[N]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (NodeDescriptor[N]) ⇒ Boolean): NodeDescriptor[N]

    Permalink
    Implicit information
    This member is added by an implicit conversion from NodeDescriptor[N] to Ensuring[NodeDescriptor[N]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): NodeDescriptor[N]

    Permalink
    Implicit information
    This member is added by an implicit conversion from NodeDescriptor[N] to Ensuring[NodeDescriptor[N]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): NodeDescriptor[N]

    Permalink
    Implicit information
    This member is added by an implicit conversion from NodeDescriptor[N] to Ensuring[NodeDescriptor[N]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  15. def extract(jsonNode: JValue): N

    Permalink
  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. implicit val formats: Formats

    Permalink
  18. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from NodeDescriptor[N] to StringFormat[NodeDescriptor[N]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  22. val manifests: List[Manifest[_]]

    Permalink
  23. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  27. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  28. val typeId: String

    Permalink

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

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

    Definition Classes
    NodeDescriptorTypeId
  29. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. def [B](y: B): (NodeDescriptor[N], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from NodeDescriptor[N] to ArrowAssoc[NodeDescriptor[N]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from TypeId

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped