class RestrictedSerializer

serialization :: RestrictedSerializer

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

As with standard Nit, additional level of customization can be achieved by adding more double-dispatching :) We can thus choose to locate the specific behavior in the serializer, or the serializees.

Introduced properties

Redefined properties

redef type SELF: RestrictedSerializer

serialization $ RestrictedSerializer :: SELF

Type of this instance, automatically specialized in every class
redef fun serialize_attribute(name: String, value: nullable Object)

serialization $ RestrictedSerializer :: serialize_attribute

This method is called when trying to serialize a specific attribute
redef fun serialize_core(value: Serializable)

serialization $ RestrictedSerializer :: serialize_core

This method is called to generate the attributes of a serialized representation

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::RestrictedSerializer RestrictedSerializer serialization::Serializer Serializer serialization::RestrictedSerializer->serialization::Serializer core::Object Object serialization::Serializer->core::Object ...core::Object ... ...core::Object->core::Object serialization::RestrictedJsonSerializer RestrictedJsonSerializer serialization::RestrictedJsonSerializer->serialization::RestrictedSerializer

Ancestors

interface Object

core :: Object

The root of the class hierarchy.

Parents

interface Serializer

serialization :: Serializer

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

Children

class RestrictedJsonSerializer

serialization :: RestrictedJsonSerializer

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

Class definitions

serialization $ RestrictedSerializer 
# Extends Serializer and adds specific business behaviors when dealing with business objects.
#
# As with standard Nit, additional level of customization can be achieved by adding more double-dispatching :)
# We can thus choose to locate the specific behavior in the serializer, or the serializees.
class RestrictedSerializer
	super Serializer

	# This method is called to generate the attributes of a serialized representation
	redef fun serialize_core(value)
	do
		super

		if value isa E then
			# Inject additional special domain-specific information
			serialize_attribute("more-data", value.phantom)
		end
	end

	# This method is called when trying to serialize a specific attribute
	redef fun serialize_attribute(name, value)
	do
		var recv = current_object
		if recv isa E then
			# do not serialize `E::semi_private`
			if name == "semi_private" then return
		end

		if value isa E then
			# Do not serialize references to `E`.
			# Just use a domain-specific value that make sense in the business logic.
			serialize_attribute(name, "ID:" + value.id)
			return
		end

		super
	end
end
lib/serialization/examples/custom_serialization.nit:86,1--122,3
Nit standard library. Version v0.8-3595-g3f58b4f.