Abstract serialization service to be sub-classed by specialized services.

Introduced properties

protected abstract fun current_object: nullable Object

serialization :: Serializer :: current_object

The object currently serialized by serialized
abstract fun serialize(object: nullable Serializable)

serialization :: Serializer :: serialize

Entry point method of this service, serialize the object
fun serialize_attribute(name: String, value: nullable Object)

serialization :: Serializer :: serialize_attribute

Serialize an attribute to compose a serializable object
fun serialize_core(value: Serializable)

serialization :: Serializer :: serialize_core

The method is called when a standard value is serialized
protected abstract fun serialize_reference(object: Serializable)

serialization :: Serializer :: serialize_reference

Serialize an object, with full serialization or a simple reference
fun try_to_serialize(value: nullable Object): Bool

serialization :: Serializer :: try_to_serialize

Serialize value is possible, i.e. it is Serializable or null
fun warn(msg: String)

serialization :: Serializer :: warn

Warn of problems and potential errors (such as if an attribute

Redefined properties

redef type SELF: Serializer

serialization $ Serializer :: SELF

Type of this instance, automatically specialized in every class

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 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.
protected abstract fun current_object: nullable Object

serialization :: Serializer :: current_object

The object currently serialized by serialized
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.
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
abstract fun serialize(object: nullable Serializable)

serialization :: Serializer :: serialize

Entry point method of this service, serialize the object
fun serialize_attribute(name: String, value: nullable Object)

serialization :: Serializer :: serialize_attribute

Serialize an attribute to compose a serializable object
fun serialize_core(value: Serializable)

serialization :: Serializer :: serialize_core

The method is called when a standard value is serialized
protected abstract fun serialize_reference(object: Serializable)

serialization :: Serializer :: serialize_reference

Serialize an object, with full serialization or a simple reference
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_s: String

core :: Object :: to_s

User readable representation of self.
fun try_to_serialize(value: nullable Object): Bool

serialization :: Serializer :: try_to_serialize

Serialize value is possible, i.e. it is Serializable or null
fun warn(msg: String)

serialization :: Serializer :: warn

Warn of problems and potential errors (such as if an attribute
package_diagram serialization::Serializer Serializer core::Object Object serialization::Serializer->core::Object serialization::CachingSerializer CachingSerializer serialization::CachingSerializer->serialization::Serializer msgpack::AttributeCounter AttributeCounter msgpack::AttributeCounter->serialization::Serializer serialization::RestrictedSerializer RestrictedSerializer serialization::RestrictedSerializer->serialization::Serializer json::JsonSerializer JsonSerializer json::JsonSerializer->serialization::CachingSerializer msgpack::MsgPackSerializer MsgPackSerializer msgpack::MsgPackSerializer->serialization::CachingSerializer json::JsonSerializer... ... json::JsonSerializer...->json::JsonSerializer msgpack::MsgPackSerializer... ... msgpack::MsgPackSerializer...->msgpack::MsgPackSerializer serialization::RestrictedJsonSerializer RestrictedJsonSerializer serialization::RestrictedJsonSerializer->serialization::RestrictedSerializer serialization::RestrictedJsonSerializer... ... serialization::RestrictedJsonSerializer...->serialization::RestrictedJsonSerializer

Parents

interface Object

core :: Object

The root of the class hierarchy.

Children

class AttributeCounter

msgpack :: AttributeCounter

Serialization visitor to count attribute in Serializable objects
abstract class CachingSerializer

serialization :: CachingSerializer

A Serializer with a cache
class RestrictedSerializer

serialization :: RestrictedSerializer

Extends Serializer and adds specific business behaviors when dealing with business objects.

Descendants

class JsonSerializer

json :: JsonSerializer

Serializer of Nit objects to Json string.
class MsgPackSerializer

msgpack :: MsgPackSerializer

MessagePack deserialization engine
class RestrictedJsonSerializer

serialization :: RestrictedJsonSerializer

Extends JsonSerializer and adds specific business behaviors when dealing with business objects.

Class definitions

serialization $ Serializer
# Abstract serialization service to be sub-classed by specialized services.
interface Serializer
	# Entry point method of this service, serialize the `object`
	#
	# This method, and refinements, should handle `null` and probably
	# use double dispatch to customize the bahavior per serializable objects.
	fun serialize(object: nullable Serializable) is abstract

	# The object currently serialized by `serialized`
	#
	# Can be used by a custom serializer to add domain-specific serialization behavior.
	protected fun current_object: nullable Object is abstract

	# Serialize an object, with full serialization or a simple reference
	protected fun serialize_reference(object: Serializable) is abstract

	# Serialize an attribute to compose a serializable object
	#
	# This method should be called from `Serializable::core_serialize_to`.
	fun serialize_attribute(name: String, value: nullable Object)
	do
		if not try_to_serialize(value) then
			assert value != null # null would have been serialized
			warn("argument {name} of type {value.class_name} is not serializable.")
		end
	end

	# Serialize `value` is possible, i.e. it is `Serializable` or `null`
	fun try_to_serialize(value: nullable Object): Bool
	do
		if value isa Serializable then
			value.serialize_to_or_delay(self)
		else if value == null then
			serialize value
		else return false
		return true
	end

	# The method is called when a standard `value` is serialized
	#
	# The default behavior is to call `value.core_serialize_to(self)` but it
	# can be redefined by a custom serializer to add domain-specific serialization behavior.
	fun serialize_core(value: Serializable)
	do
		value.core_serialize_to(self)
	end

	# Warn of problems and potential errors (such as if an attribute
	# is not serializable)
	fun warn(msg: String) do print "Serialization warning: {msg}"
end
lib/serialization/serialization_core.nit:55,1--105,3