interface IDisposableGeneric in Tinman.Core.System

Base interface for IDisposable implementations that provide a base interface as syntactic sugar for AcquireThrow.

interface	IDisposableGeneric	with	<out T>	as	IDisposable
		extends	IDisposable
		base of	ByteBuffer
			IApplication
			IApplicationWindow
			IBrush
			IDataStream
			IFile
			IHeightmap
			IImageReader
			IModelReader
			IPixelPyramid
			IResource
			IShapeReader
			ISimpleHttp
			ITexelPyramid
			ITextStream
			TerrainBuffer
			TexelBuffer

Attributes

IsSoleOwnership

Will this object be disposed upon the next call to Dispose?

[ThreadSafe]
property	IsSoleOwnership { get }
type	bool
value		true if the object will be disposed when Dispose is called, false if the object will not be disposed, because some other code is still holding shared ownership (see AcquireThrow).
inherited	IDisposable.IsSoleOwnership

LifecycleState

Returns the lifecycle state of this object.

property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	ILifecycleState.LifecycleState

Methods

Acquire

Acquires a strong reference to this disposable object.

[OwnerReturn, Pure]
method	Acquire ()
type	T
returns			The strong reference to this disposable object or null iff this object is no longer valid.

Remarks:

The object will not be actually disposed by calls to Dispose when there is at least one strong reference left. Code that calls this method is responsible for calling the Dispose method accordingly.

This method is not intended to be used in performance-critical code. It should only be used to high-level resource management.

AcquireBase

Acquires a strong reference to this disposable object.

[OwnerReturn, Pure]
method	AcquireBase ()
type	IDisposable
returns			The strong reference to this disposable object or null iff this object is no longer valid.
inherited	IDisposable.AcquireBase

Remarks:

The object will not be actually disposed by calls to IDisposable when there is at least one strong reference left. Code that calls this method is responsible for calling the IDisposable method accordingly.

This method is not intended to be used in performance-critical code. It should only be used to high-level resource management.

Using this method usually requires type casting. Subclasses may additionally implement IDisposableGeneric, in order to provide some syntactic sugar for that.

AcquireThrow

Acquires a strong reference to this disposable object.

[OwnerReturn, Pure]
method	AcquireThrow ()
type	IDisposable
returns		[not-null]	The strong reference to this disposable object.
inherited	IDisposable.AcquireThrow

Remarks:

The object will not be actually disposed by calls to IDisposable when there is at least one strong reference left. Code that calls this method is responsible for calling the IDisposable method accordingly.

This method is not intended to be used in performance-critical code. It should only be used to high-level resource management.

Exceptions:

• TinmanException:
  If this object is no longer valid.

Dispose

Releases all resources held by this object if there are no more strong references to it, decrements the reference counter by one otherwise.

[Dispose, OwnerThis, ThreadSafe]
method	Dispose ()
inherited	IDisposable.Dispose

Remarks:

The Dispose method silently returns if the object has already been disposed.

Implementing methods must not throw any exceptions.