An object to be finalized only once

This is an utility sub-class to Finalizable which ensures that finalized_once is called only once per instance. User classes implementing FinalizableOnce shoud specialize finalize_once and not finalize. When manipulating the user class, only finalize should be called as it protects finalize_once.

Introduced properties

protected fun finalize_once

core :: FinalizableOnce :: finalize_once

Real finalization method of FinalizableOnce, will be called only once
fun finalized: Bool

core :: FinalizableOnce :: finalized

Has self been finalized? (either by the GC or an explicit call to finalize)
protected fun finalized=(finalized: Bool)

core :: FinalizableOnce :: finalized=

Has self been finalized? (either by the GC or an explicit call to finalize)

Redefined properties

redef type SELF: FinalizableOnce

core $ FinalizableOnce :: SELF

Type of this instance, automatically specialized in every class
redef fun finalize

core $ FinalizableOnce :: finalize

Liberate any resources held by self before the memory holding self is freed

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.
fun finalize

core :: Finalizable :: finalize

Liberate any resources held by self before the memory holding self is freed
protected fun finalize_once

core :: FinalizableOnce :: finalize_once

Real finalization method of FinalizableOnce, will be called only once
fun finalized: Bool

core :: FinalizableOnce :: finalized

Has self been finalized? (either by the GC or an explicit call to finalize)
protected fun finalized=(finalized: Bool)

core :: FinalizableOnce :: finalized=

Has self been finalized? (either by the GC or an explicit call to finalize)
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
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.
package_diagram core::FinalizableOnce FinalizableOnce core::Finalizable Finalizable core::FinalizableOnce->core::Finalizable core::Object Object core::Finalizable->core::Object ...core::Object ... ...core::Object->core::Object core::FinalizableOnce... ... core::FinalizableOnce...->core::FinalizableOnce

Ancestors

interface Object

core :: Object

The root of the class hierarchy.

Parents

class Finalizable

core :: Finalizable

An object needing finalization

Children

class BigInt

gmp :: BigInt

Multi precision Integer numbers.
class Clock

realtime :: Clock

Keeps track of real time
class GLfloatArray

glesv2 :: GLfloatArray

Low level array of Float
class MongoClient

mongodb :: MongoClient

The MongoClient is used to connect to the mongo server and send queries.
class MongoCollection

mongodb :: MongoCollection

A Mongo collection.
class MongoCursor

mongodb :: MongoCursor

A MongoDB query cursor.
class MongoDb

mongodb :: MongoDb

A MongoDb database.
class PollFD

socket :: PollFD

Wrapper for the data structure used for polling on a socket
class PthreadCond

pthreads :: PthreadCond

Condition variable
class Ratio

gmp :: Ratio

Multi precision Rational numbers.
class SocketAddress

socket :: SocketAddress

Address of a socket in the Internet namespace

Class definitions

core $ FinalizableOnce
# An object to be finalized only once
#
# This is an utility sub-class to `Finalizable` which ensures that `finalized_once`
# is called only once per instance. User classes implementing `FinalizableOnce`
# shoud specialize `finalize_once` and _not_ `finalize`. When manipulating the user
# class, only `finalize` should be called as it protects `finalize_once`.
class FinalizableOnce
	super Finalizable

	# Has `self` been finalized? (either by the GC or an explicit call to `finalize`)
	var finalized = false

	redef fun finalize
	do
		if finalized then return

		finalize_once
		finalized = true
	end

	# Real finalization method of `FinalizableOnce`, will be called only once
	#
	# See: `Finalizable::finalize` for restrictions on finalizer methods.
	protected fun finalize_once do end
end
lib/core/gc.nit:40,1--64,3