Abstract deserialization service

The main service is deserialize.

Introduced properties

abstract fun deserialize(static_type: nullable String): nullable Object

serialization :: Deserializer :: deserialize

Deserialize and return an object, storing errors in the attribute errors
abstract fun deserialize_attribute(name: String, static_type: nullable String): nullable Object

serialization :: Deserializer :: deserialize_attribute

Deserialize the attribute with name from the object open for deserialization
fun deserialize_attribute_missing: Bool

serialization :: Deserializer :: deserialize_attribute_missing

Was the attribute queried by the last call to deserialize_attribute missing?
protected fun deserialize_attribute_missing=(deserialize_attribute_missing: Bool)

serialization :: Deserializer :: deserialize_attribute_missing=

Was the attribute queried by the last call to deserialize_attribute missing?
protected fun deserialize_class(class_name: Text): nullable Object

serialization :: Deserializer :: deserialize_class

Deserialize the next available object as an instance of class_name
protected fun deserialize_class_intern(class_name: Text): nullable Object

serialization :: Deserializer :: deserialize_class_intern

Generated service to deserialize the next available object as an instance of class_name
fun errors: Array[Error]

serialization :: Deserializer :: errors

Errors encountered in the last call to deserialize
protected fun errors=(errors: Array[Error])

serialization :: Deserializer :: errors=

Errors encountered in the last call to deserialize
fun keep_going: nullable Bool

serialization :: Deserializer :: keep_going

Should self keep trying to deserialize an object after an error?
fun keep_going=(keep_going: nullable Bool)

serialization :: Deserializer :: keep_going=

Should self keep trying to deserialize an object after an error?
abstract fun notify_of_creation(new_object: Object)

serialization :: Deserializer :: notify_of_creation

Register a newly allocated object (even if not completely built)

Redefined properties

redef type SELF: Deserializer

serialization $ Deserializer :: SELF

Type of this instance, automatically specialized in every class
redef fun core_serialize_to(v: Serializer)

more_collections :: more_collections $ Deserializer :: core_serialize_to

Actual serialization of self to serializer
redef fun core_serialize_to(v: Serializer)

geometry :: points_and_lines $ Deserializer :: core_serialize_to

Actual serialization of self to serializer
redef fun core_serialize_to(v: Serializer)

bucketed_game :: bucketed_game $ Deserializer :: core_serialize_to

Actual serialization of self to serializer
redef fun core_serialize_to(v: Serializer)

noise :: noise $ Deserializer :: core_serialize_to

Actual serialization of self to serializer
redef fun deserialize_class(name: Text): nullable Object

serialization :: safe $ Deserializer :: deserialize_class

Deserialize the next available object as an instance of class_name
redef fun deserialize_class_intern(name: Text): nullable Object

nitcc_runtime :: nitcc_runtime $ Deserializer :: deserialize_class_intern

Generated service to deserialize the next available object as an instance of class_name
redef fun deserialize_class_intern(name: Text): nullable Object

nitcorn :: http_request $ Deserializer :: deserialize_class_intern

Generated service to deserialize the next available object as an instance of class_name
redef fun deserialize_class_intern(name: Text): nullable Object

noise :: noise $ Deserializer :: deserialize_class_intern

Generated service to deserialize the next available object as an instance of class_name
redef fun deserialize_class_intern(name: Text): nullable Object

msgpack :: ext $ Deserializer :: deserialize_class_intern

Generated service to deserialize the next available object as an instance of class_name
redef fun deserialize_class_intern(name: Text): nullable Object

parser_base :: parser_base $ Deserializer :: deserialize_class_intern

Generated service to deserialize the next available object as an instance of class_name
redef fun deserialize_class_intern(name: Text): nullable Object

json :: error $ Deserializer :: deserialize_class_intern

Generated service to deserialize the next available object as an instance of class_name
redef fun deserialize_class_intern(name: Text): nullable Object

more_collections :: more_collections $ Deserializer :: deserialize_class_intern

Generated service to deserialize the next available object as an instance of class_name
redef fun deserialize_class_intern(name: Text): nullable Object

geometry :: points_and_lines $ Deserializer :: deserialize_class_intern

Generated service to deserialize the next available object as an instance of class_name
redef fun deserialize_class_intern(name: Text): nullable Object

a_star :: a_star $ Deserializer :: deserialize_class_intern

Generated service to deserialize the next available object as an instance of class_name
redef fun deserialize_class_intern(name: Text): nullable Object

serialization :: custom_serialization $ Deserializer :: deserialize_class_intern

Generated service to deserialize the next available object as an instance of class_name
redef fun deserialize_class_intern(name: Text): nullable Object

nitcorn :: http_response $ Deserializer :: deserialize_class_intern

Generated service to deserialize the next available object as an instance of class_name
redef fun deserialize_class_intern(name: Text): nullable Object

github :: loader $ Deserializer :: deserialize_class_intern

Generated service to deserialize the next available object as an instance of class_name
redef fun deserialize_class_intern(name: Text): nullable Object

bucketed_game :: bucketed_game $ Deserializer :: deserialize_class_intern

Generated service to deserialize the next available object as an instance of class_name
redef fun deserialize_class_intern(name: Text): nullable Object

popcorn :: pop_tracker $ Deserializer :: deserialize_class_intern

Generated service to deserialize the next available object as an instance of class_name
redef fun deserialize_class_intern(name: Text): nullable Object

nitcorn :: restful_annot $ Deserializer :: deserialize_class_intern

Generated service to deserialize the next available object as an instance of class_name
redef fun deserialize_class_intern(name: Text): nullable Object

neo4j :: error $ Deserializer :: deserialize_class_intern

Generated service to deserialize the next available object as an instance of class_name
redef fun deserialize_class_intern(name: Text): nullable Object

curl :: curl_rest $ Deserializer :: deserialize_class_intern

Generated service to deserialize the next available object as an instance of class_name
redef fun deserialize_class_intern(name: Text): nullable Object

mpi :: mpi_simple $ Deserializer :: deserialize_class_intern

Generated service to deserialize the next available object as an instance of class_name
redef fun deserialize_class_intern(name: Text): nullable Object

github :: api $ Deserializer :: deserialize_class_intern

Generated service to deserialize the next available object as an instance of class_name
redef fun deserialize_class_intern(name: Text): nullable Object

github :: events $ Deserializer :: deserialize_class_intern

Generated service to deserialize the next available object as an instance of class_name
redef fun deserialize_class_intern(name: Text): nullable Object

popcorn :: pop_repos $ Deserializer :: deserialize_class_intern

Generated service to deserialize the next available object as an instance of class_name
redef init from_deserializer(v: Deserializer)

bucketed_game :: bucketed_game $ Deserializer :: from_deserializer

Create an instance of this class from the deserializer
redef init from_deserializer(v: Deserializer)

geometry :: points_and_lines $ Deserializer :: from_deserializer

Create an instance of this class from the deserializer
redef init from_deserializer(v: Deserializer)

noise :: noise $ Deserializer :: from_deserializer

Create an instance of this class from the deserializer
redef init from_deserializer(v: Deserializer)

more_collections :: more_collections $ Deserializer :: from_deserializer

Create an instance of this class from the deserializer

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?
type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
protected fun accept_json_serializer(v: JsonSerializer)

serialization :: Serializable :: accept_json_serializer

Refinable service to customize the serialization of this class to JSON
protected fun accept_msgpack_attribute_counter(v: AttributeCounter)

serialization :: Serializable :: accept_msgpack_attribute_counter

Hook to customize the behavior of the AttributeCounter
protected fun accept_msgpack_serializer(v: MsgPackSerializer)

serialization :: Serializable :: accept_msgpack_serializer

Hook to customize the serialization of this class to MessagePack
protected fun add_to_bundle(bundle: NativeBundle, key: JavaString)

serialization :: Serializable :: add_to_bundle

Called by []= to dynamically choose the appropriate method according
protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.
fun class_name: String

core :: Object :: class_name

The class name of the object.
fun core_serialize_to(serializer: Serializer)

serialization :: Serializable :: core_serialize_to

Actual serialization of self to serializer
abstract fun deserialize(static_type: nullable String): nullable Object

serialization :: Deserializer :: deserialize

Deserialize and return an object, storing errors in the attribute errors
abstract fun deserialize_attribute(name: String, static_type: nullable String): nullable Object

serialization :: Deserializer :: deserialize_attribute

Deserialize the attribute with name from the object open for deserialization
fun deserialize_attribute_missing: Bool

serialization :: Deserializer :: deserialize_attribute_missing

Was the attribute queried by the last call to deserialize_attribute missing?
protected fun deserialize_attribute_missing=(deserialize_attribute_missing: Bool)

serialization :: Deserializer :: deserialize_attribute_missing=

Was the attribute queried by the last call to deserialize_attribute missing?
protected fun deserialize_class(class_name: Text): nullable Object

serialization :: Deserializer :: deserialize_class

Deserialize the next available object as an instance of class_name
protected fun deserialize_class_intern(class_name: Text): nullable Object

serialization :: Deserializer :: deserialize_class_intern

Generated service to deserialize the next available object as an instance of class_name
fun errors: Array[Error]

serialization :: Deserializer :: errors

Errors encountered in the last call to deserialize
protected fun errors=(errors: Array[Error])

serialization :: Deserializer :: errors=

Errors encountered in the last call to deserialize
init from_deserializer(deserializer: Deserializer)

serialization :: Serializable :: from_deserializer

Create an instance of this class from the deserializer
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun hash: Int

core :: Object :: hash

The hash code of the object.
init init

core :: Object :: init

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.
protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".
intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).
fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?
intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.
fun keep_going: nullable Bool

serialization :: Deserializer :: keep_going

Should self keep trying to deserialize an object after an error?
fun keep_going=(keep_going: nullable Bool)

serialization :: Deserializer :: keep_going=

Should self keep trying to deserialize an object after an error?
protected fun msgpack_extra_array_items: Int

serialization :: Serializable :: msgpack_extra_array_items

Hook to request a larger than usual metadata array
abstract fun notify_of_creation(new_object: Object)

serialization :: Deserializer :: notify_of_creation

Register a newly allocated object (even if not completely built)
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
fun output

core :: Object :: output

Display self on stdout (debug only).
intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
fun serialize_msgpack(plain: nullable Bool): Bytes

serialization :: Serializable :: serialize_msgpack

Serialize self to MessagePack bytes
fun serialize_to(serializer: Serializer)

serialization :: Serializable :: serialize_to

Serialize self to serializer
fun serialize_to_json(plain: nullable Bool, pretty: nullable Bool): String

serialization :: Serializable :: serialize_to_json

Serialize self to JSON
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
fun to_json: String

serialization :: Serializable :: to_json

Serialize self to plain JSON
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_pretty_json: String

serialization :: Serializable :: to_pretty_json

Serialize self to plain pretty JSON
fun to_s: String

core :: Object :: to_s

User readable representation of self.
package_diagram serialization::Deserializer Deserializer serialization::Serializable Serializable serialization::Deserializer->serialization::Serializable core::Object Object serialization::Serializable->core::Object ...core::Object ... ...core::Object->core::Object serialization::CachingDeserializer CachingDeserializer serialization::CachingDeserializer->serialization::Deserializer serialization::SafeDeserializer SafeDeserializer serialization::SafeDeserializer->serialization::Deserializer json::JsonDeserializer JsonDeserializer json::JsonDeserializer->serialization::CachingDeserializer json::JsonDeserializer->serialization::SafeDeserializer msgpack::MsgPackDeserializer MsgPackDeserializer msgpack::MsgPackDeserializer->serialization::CachingDeserializer msgpack::MsgPackDeserializer->serialization::SafeDeserializer json::JsonDeserializer... ... json::JsonDeserializer...->json::JsonDeserializer msgpack::MsgPackDeserializer... ... msgpack::MsgPackDeserializer...->msgpack::MsgPackDeserializer

Ancestors

interface Object

core :: Object

The root of the class hierarchy.

Parents

interface Serializable

serialization :: Serializable

Instances of this class can be passed to Serializer::serialize

Children

abstract class CachingDeserializer

serialization :: CachingDeserializer

A Deserializer with a cache
class SafeDeserializer

serialization :: SafeDeserializer

Deserialization engine limiting which types can be deserialized

Descendants

class GithubDeserializer

github :: GithubDeserializer

JsonDeserializer specific for Github objects.
class JsonDeserializer

json :: JsonDeserializer

Deserializer from a Json string.
class MsgPackDeserializer

msgpack :: MsgPackDeserializer

Deserialize MessagePack format to full Nit objects

Class definitions

serialization $ Deserializer
# Abstract deserialization service
#
# The main service is `deserialize`.
abstract class Deserializer
	# Deserialize and return an object, storing errors in the attribute `errors`
	#
	# If a `static_type` is given, only subtypes of the `static_type` are accepted.
	#
	# This method behavior varies according to the implementation engines.
	fun deserialize(static_type: nullable String): nullable Object is abstract

	# Deserialize the attribute with `name` from the object open for deserialization
	#
	# The `static_type` restricts what kind of object can be deserialized.
	#
	# Return the deserialized value or null on error, and set
	# `deserialize_attribute_missing` to whether the attribute was missing.
	#
	# Internal method to be implemented by the engines.
	fun deserialize_attribute(name: String, static_type: nullable String): nullable Object is abstract

	# Was the attribute queried by the last call to `deserialize_attribute` missing?
	var deserialize_attribute_missing = false

	# Register a newly allocated object (even if not completely built)
	#
	# Internal method called by objects in creation, to be implemented by the engines.
	fun notify_of_creation(new_object: Object) is abstract

	# Deserialize the next available object as an instance of `class_name`
	#
	# Return the deserialized object on success and
	# record in `errors` if `class_name` is unknown.
	#
	# This method should be redefined for each custom subclass of `Serializable`.
	# All refinement should look for a precise `class_name` and call super
	# on unsupported classes.
	protected fun deserialize_class(class_name: Text): nullable Object do
		if class_name == "Error" then return new Error.from_deserializer(self)
		return deserialize_class_intern(class_name)
	end

	# Generated service to deserialize the next available object as an instance of `class_name`
	#
	# Refinements to this method will be generated by the serialization phase.
	# To avoid conflicts, there should not be any other refinements to this method.
	# You can instead use `deserialize_class`.
	protected fun deserialize_class_intern(class_name: Text): nullable Object do
		errors.add new Error("Deserialization Error: Doesn't know how to deserialize class \"{class_name}\"")
		return null
	end

	# Should `self` keep trying to deserialize an object after an error?
	#
	# This behavior takes effect after each attribute deserialization with
	# errors such as a missing attribute or the value is of the wrong type.
	# If `keep_going`, the attribute will be skipped but the engine will
	# deserialize the next attribute.
	# If `not keep_going`, the engine stops deserializing right away.
	#
	# When at `true`, this may cause the accumulation of a lot of entries in `errors`.
	#
	# Default at `true`.
	var keep_going: nullable Bool = null is writable

	# Errors encountered in the last call to `deserialize`
	var errors = new Array[Error]
end
lib/serialization/serialization_core.nit:107,1--174,3

a_star :: a_star $ Deserializer
redef class Deserializer
	redef fun deserialize_class_intern(name) do abort
end
1,1--3,3

msgpack :: ext $ Deserializer
redef class Deserializer
	redef fun deserialize_class_intern(name) do abort
end
1,1--3,3

nitcc_runtime :: nitcc_runtime $ Deserializer
redef class Deserializer
	redef fun deserialize_class_intern(name) do abort
end
1,1--3,3

nitcorn :: http_request $ Deserializer
redef class Deserializer
	redef fun deserialize_class_intern(name) do abort
end
1,1--3,3

parser_base :: parser_base $ Deserializer
redef class Deserializer
	redef fun deserialize_class_intern(name) do abort
end
1,1--3,3

nitcorn :: http_response $ Deserializer
redef class Deserializer
	redef fun deserialize_class_intern(name) do abort
end
1,1--3,3

serialization :: custom_serialization $ Deserializer
redef class Deserializer
	redef fun deserialize_class_intern(name) do abort
end
1,1--3,3

json :: error $ Deserializer
redef class Deserializer
	redef fun deserialize_class_intern(name) do abort
end
1,1--3,3

geometry :: points_and_lines $ Deserializer
redef class Deserializer
	redef fun deserialize_class_intern(name) do abort
end
1,1--3,3

noise :: noise $ Deserializer
redef class Deserializer
	redef fun deserialize_class_intern(name) do abort
end
1,1--3,3

more_collections :: more_collections $ Deserializer
redef class Deserializer
	redef fun deserialize_class_intern(name) do abort
end
1,1--3,3

bucketed_game :: bucketed_game $ Deserializer
redef class Deserializer
	redef fun deserialize_class_intern(name) do abort
end
1,1--3,3

neo4j :: error $ Deserializer
redef class Deserializer
	redef fun deserialize_class_intern(name) do abort
end
1,1--3,3

curl :: curl_rest $ Deserializer
redef class Deserializer
	redef fun deserialize_class_intern(name) do abort
end
1,1--3,3

mpi :: mpi_simple $ Deserializer
redef class Deserializer
	redef fun deserialize_class_intern(name) do abort
end
1,1--3,3

github :: api $ Deserializer
redef class Deserializer
	redef fun deserialize_class_intern(name) do abort
end
1,1--3,3

popcorn :: pop_repos $ Deserializer
redef class Deserializer
	redef fun deserialize_class_intern(name) do abort
end
1,1--3,3

github :: events $ Deserializer
redef class Deserializer
	redef fun deserialize_class_intern(name) do abort
end
1,1--3,3

nitcorn :: restful_annot $ Deserializer
redef class Deserializer
	redef fun deserialize_class_intern(name) do abort
end
1,1--3,3

popcorn :: pop_tracker $ Deserializer
redef class Deserializer
	redef fun deserialize_class_intern(name) do abort
end
1,1--3,3

github :: loader $ Deserializer
redef class Deserializer
	redef fun deserialize_class_intern(name) do abort
end
1,1--3,3