org.opendaylight.yangtools.concepts

Interface ObjectRegistration<T>

All Superinterfaces:

AutoCloseable, Registration

All Known Subinterfaces:

ListenerRegistration<T>, SchemaListenerRegistration, SchemaSourceRegistration<T>, YangTextSchemaSourceRegistration

All Known Implementing Classes:

AbstractListenerRegistration, AbstractObjectRegistration, AbstractSchemaListenerRegistration, AbstractSchemaSourceRegistration, AbstractYangTextSchemaSourceRegistration

public interface ObjectRegistration<T>
extends Registration

Class representing a registration of an object. Such a registration is a proper resource and should be cleaned up when no longer required, so references to the object can be removed. This mechanism lies above the usual Java reference mechanism, as the entity where the object is registered may reside outside of the Java Virtual Machine.

Method Summary

Modifier and Type	Method and Description
void	close() Unregisters the object.
T	getInstance() Return the object instance.

Method Detail

getInstance

@Nonnull
T getInstance()

Return the object instance.

Returns:

Registered object.

close

void close()
    throws Exception

Unregisters the object. This operation is required not to invoke blocking operations. Implementations which require interaction with outside world must provide guarantees that any work is done behind the scenes and the unregistration process looks as if it has already succeeded once this method returns.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Registration

Throws:

Exception