note
	description: "Decoding of arbitrary objects graphs between sessions of a same program."
	legal: "See notice at end of class."
	status: "See notice at end of class."
	date: "$Date: 2020-05-19 14:29:33 +0000 (Tue, 19 May 2020) $"
	revision: "$Revision: 104259 $"

class interface
	SED_BASIC_DESERIALIZER

create 
	make (a_deserializer: SED_READER_WRITER)
			-- Initialize current instance
			-- (from SED_SESSION_DESERIALIZER)
		require -- from SED_SESSION_DESERIALIZER
			a_deserializer_not_void: a_deserializer /= Void
			a_deserializer_ready: a_deserializer.is_ready_for_reading
		ensure -- from SED_SESSION_DESERIALIZER
			deserializer_set: deserializer = a_deserializer

feature -- Access

	deserializer: SED_READER_WRITER
			-- Serializer used to decode data
			-- (from SED_SESSION_DESERIALIZER)

	generating_type: TYPE [detachable SED_BASIC_DESERIALIZER]
			-- Type of current object
			-- (type of which it is a direct instance)
			-- (from ANY)
		ensure -- from ANY
			generating_type_not_void: Result /= Void

	generator: STRING_8
			-- Name of current object's generating class
			-- (base class of the type of which it is a direct instance)
			-- (from ANY)
		ensure -- from ANY
			generator_not_void: Result /= Void
			generator_not_empty: not Result.is_empty

	last_decoded_object: detachable ANY
			-- Object decoded during last call to decode
			-- (from SED_SESSION_DESERIALIZER)

	last_exception: detachable EXCEPTION
			-- Last exception
			-- (from EXCEPTION_MANAGER)
		ensure -- from EXCEPTION_MANAGER
			instance_free: class
	
feature -- Comparison

	frozen deep_equal (a: detachable ANY; b: like arg #1): BOOLEAN
			-- Are a and b either both void
			-- or attached to isomorphic object structures?
			-- (from ANY)
		ensure -- from ANY
			instance_free: class
			shallow_implies_deep: standard_equal (a, b) implies Result
			both_or_none_void: (a = Void) implies (Result = (b = Void))
			same_type: (Result and (a /= Void)) implies (b /= Void and then a.same_type (b))
			symmetric: Result implies deep_equal (b, a)

	frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN
			-- Are a and b either both void or attached
			-- to objects considered equal?
			-- (from ANY)
		ensure -- from ANY
			instance_free: class
			definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b))

	frozen is_deep_equal alias "≡≡≡" (other: SED_BASIC_DESERIALIZER): BOOLEAN
			-- Are Current and other attached to isomorphic object structures?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			shallow_implies_deep: standard_is_equal (other) implies Result
			same_type: Result implies same_type (other)
			symmetric: Result implies other.is_deep_equal (Current)

	is_equal (other: SED_BASIC_DESERIALIZER): BOOLEAN
			-- Is other attached to an object considered
			-- equal to current object?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			symmetric: Result implies other ~ Current
			consistent: standard_is_equal (other) implies Result

	frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN
			-- Are a and b either both void or attached to
			-- field-by-field identical objects of the same type?
			-- Always uses default object comparison criterion.
			-- (from ANY)
		ensure -- from ANY
			instance_free: class
			definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b))

	frozen standard_is_equal alias "≜" (other: SED_BASIC_DESERIALIZER): BOOLEAN
			-- Is other attached to an object of the same type
			-- as current object, and field-by-field identical to it?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			same_type: Result implies same_type (other)
			symmetric: Result implies other.standard_is_equal (Current)
	
feature -- Status report

	conforms_to (other: ANY): BOOLEAN
			-- Does type of current object conform to type
			-- of other (as per Eiffel: The Language, chapter 13)?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void

	errors: detachable ARRAYED_LIST [SED_ERROR]
			-- (from SED_SESSION_DESERIALIZER)

	has_error: BOOLEAN
			-- Did we encounter an error during retrieval?
			-- (from SED_SESSION_DESERIALIZER)

	is_caught (a_exception: TYPE [detachable EXCEPTION]): BOOLEAN
			-- If set, type of a_exception is raised.
			-- (from EXCEPTION_MANAGER)
		ensure -- from EXCEPTION_MANAGER
			instance_free: class
			not_is_ignored: Result = not is_ignored (a_exception)

	is_ignorable (a_exception: TYPE [detachable EXCEPTION]): BOOLEAN
			-- If set, type of a_exception is ignorable.
			-- (from EXCEPTION_MANAGER)
		ensure -- from EXCEPTION_MANAGER
			instance_free: class

	is_ignored (a_exception: TYPE [detachable EXCEPTION]): BOOLEAN
			-- If set, type of a_exception is not raised.
			-- (from EXCEPTION_MANAGER)
		ensure -- from EXCEPTION_MANAGER
			instance_free: class
			not_is_caught: Result = not is_caught (a_exception)

	is_raisable (a_exception: TYPE [detachable EXCEPTION]): BOOLEAN
			-- If set, type of a_exception is raisable.
			-- (from EXCEPTION_MANAGER)
		ensure -- from EXCEPTION_MANAGER
			instance_free: class

	same_type (other: ANY): BOOLEAN
			-- Is type of current object identical to type of other?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			definition: Result = (conforms_to (other) and other.conforms_to (Current))
	
feature -- Status setting

	catch (a_exception: TYPE [detachable EXCEPTION])
			-- Set type of a_exception is_caught.
			-- (from EXCEPTION_MANAGER)
		require -- from EXCEPTION_MANAGER
			a_exception_not_void: a_exception /= Void
		ensure -- from EXCEPTION_MANAGER
			instance_free: class
			is_ignored: not is_ignored (a_exception)

	ignore (a_exception: TYPE [detachable EXCEPTION])
			-- Ignore type of a_exception.
			-- (from EXCEPTION_MANAGER)
		require -- from EXCEPTION_MANAGER
			a_exception_not_void: a_exception /= Void
			is_ignorable: is_ignorable (a_exception)
		ensure -- from EXCEPTION_MANAGER
			instance_free: class
			is_caught: is_ignored (a_exception)

	set_is_ignored (a_exception: TYPE [detachable EXCEPTION]; a_ignored: BOOLEAN)
			-- Set type of a_exception to be a_ignored.
			-- (from EXCEPTION_MANAGER)
		require -- from EXCEPTION_MANAGER
			a_exception_not_void: a_exception /= Void
			a_ignored_implies_is_ignorable: a_ignored implies is_ignorable (a_exception)
		ensure -- from EXCEPTION_MANAGER
			instance_free: class
			is_ignored_set: is_ignored (a_exception) = a_ignored
	
feature -- Duplication

	copy (other: SED_BASIC_DESERIALIZER)
			-- Update current object using fields of object attached
			-- to other, so as to yield equal objects.
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
			type_identity: same_type (other)
		ensure -- from ANY
			is_equal: Current ~ other

	frozen deep_copy (other: SED_BASIC_DESERIALIZER)
			-- Effect equivalent to that of:
			--		copy (other . deep_twin)
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			deep_equal: deep_equal (Current, other)

	frozen deep_twin: SED_BASIC_DESERIALIZER
			-- New object structure recursively duplicated from Current.
			-- (from ANY)
		ensure -- from ANY
			deep_twin_not_void: Result /= Void
			deep_equal: deep_equal (Current, Result)

	frozen standard_copy (other: SED_BASIC_DESERIALIZER)
			-- Copy every field of other onto corresponding field
			-- of current object.
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
			type_identity: same_type (other)
		ensure -- from ANY
			is_standard_equal: standard_is_equal (other)

	frozen standard_twin: SED_BASIC_DESERIALIZER
			-- New object field-by-field identical to other.
			-- Always uses default copying semantics.
			-- (from ANY)
		ensure -- from ANY
			standard_twin_not_void: Result /= Void
			equal: standard_equal (Result, Current)

	frozen twin: SED_BASIC_DESERIALIZER
			-- New object equal to Current
			-- twin calls copy; to change copying/twinning semantics, redefine copy.
			-- (from ANY)
		ensure -- from ANY
			twin_not_void: Result /= Void
			is_equal: Result ~ Current
	
feature -- Basic operations

	frozen decode (a_is_gc_enabled: BOOLEAN)
			-- Decode object graph stored in deserializer.
			-- (from SED_SESSION_DESERIALIZER)

	frozen default: detachable SED_BASIC_DESERIALIZER
			-- Default value of object's type
			-- (from ANY)

	frozen default_pointer: POINTER
			-- Default value of type POINTER
			-- (Avoid the need to write p.default for
			-- some p of type POINTER.)
			-- (from ANY)
		ensure -- from ANY
			instance_free: class

	default_rescue
			-- Process exception for routines with no Rescue clause.
			-- (Default: do nothing.)
			-- (from ANY)

	frozen do_nothing
			-- Execute a null action.
			-- (from ANY)
		ensure -- from ANY
			instance_free: class
	
feature -- Output

	Io: STD_FILES
			-- Handle to standard file setup
			-- (from ANY)
		ensure -- from ANY
			instance_free: class
			io_not_void: Result /= Void

	out: STRING_8
			-- New string containing terse printable representation
			-- of current object
			-- (from ANY)
		ensure -- from ANY
			out_not_void: Result /= Void

	print (o: detachable ANY)
			-- Write terse external representation of o
			-- on standard output.
			-- (from ANY)
		ensure -- from ANY
			instance_free: class

	frozen tagged_out: STRING_8
			-- New string containing terse printable representation
			-- of current object
			-- (from ANY)
		ensure -- from ANY
			tagged_out_not_void: Result /= Void
	
feature -- Platform

	Operating_environment: OPERATING_ENVIRONMENT
			-- Objects available from the operating system
			-- (from ANY)
		ensure -- from ANY
			instance_free: class
			operating_environment_not_void: Result /= Void
	
feature -- Raise

	raise (a_exception: EXCEPTION)
			-- Raise a_exception.
			-- (from EXCEPTION_MANAGER)
		require -- from EXCEPTION_MANAGER
			a_exception_not_void: a_exception /= Void
			a_exception_is_raisable: a_exception.is_raisable
		ensure -- from EXCEPTION_MANAGER
			instance_free: class
	
feature -- Settings

	set_deserializer (a_deserializer: like deserializer)
			-- Set deserializer with a_deserializer.
			-- (from SED_SESSION_DESERIALIZER)
		require -- from SED_SESSION_DESERIALIZER
			a_deserializer_not_void: a_deserializer /= Void
			a_deserializer_ready: a_deserializer.is_ready_for_reading
		ensure -- from SED_SESSION_DESERIALIZER
			deserializer_set: deserializer = a_deserializer
	
invariant
		-- from SED_SESSION_DESERIALIZER
	reflector_not_void: reflector /= Void
	reflected_object_not_void: reflected_object /= Void
	deserializer_not_void: deserializer /= Void
	object_references_not_void: object_references /= Void

		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)

note
	library: "EiffelBase: Library of reusable components for Eiffel."
	copyright: "Copyright (c) 1984-2020, Eiffel Software and others"
	license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
	source: "[
		Eiffel Software
		5949 Hollister Ave., Goleta, CA 93117 USA
		Telephone 805-685-1006, Fax 805-685-6869
		Website http://www.eiffel.com
		Customer support http://support.eiffel.com
	]"

end -- class SED_BASIC_DESERIALIZER

Generated by ISE EiffelStudio