scalax.collection.io.json.descriptor

NodeDescriptor

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
TypeId, AnyRef, Any
Known Subclasses
StringNodeDescriptor
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. NodeDescriptor
  2. TypeId
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new NodeDescriptor(typeId: String = Defaults.defaultId, customSerializers: Traversable[Serializer[_]] = immutable.this.Nil, extraClasses: List[Class[_]] = immutable.this.Nil, furtherManifests: List[Manifest[_]] = immutable.this.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(node: Any): 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: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def decompose(node: Any): JValue

  9. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  10. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  11. def extract(jsonNode: JValue): N

  12. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  13. implicit val formats: Formats

  14. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  15. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  16. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  17. val manifests: List[Manifest[_]]

  18. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  19. final def notify(): Unit

    Definition Classes
    AnyRef

  20. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  22. def toString(): String

    Definition Classes
    AnyRef → Any

  23. val typeId: String

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

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

    Definition Classes
    NodeDescriptor → TypeId

  24. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  26. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from TypeId

Inherited from AnyRef

Inherited from Any

Ungrouped