org.netbeans.html.boot.spi

Interface Fn.Ref<P extends Fn.Presenter>

Type Parameters:

P - the type of the presenter

Enclosing class:

Fn

public static interface Fn.Ref<P extends Fn.Presenter>

Reference to a Fn.Presenter.Each implementation of a Fn.Presenter may choose a way to reference itself (usually in a weak way) effectively. Various code that needs to hold a reference to a presenter is then encouraged to obtain such reference via Fn.ref(org.netbeans.html.boot.spi.Fn.Presenter) call and hold on to it. Holding a reference to an instance of Fn.Presenter is discouraged as it may lead to memory leaks.

Presenters willing to to represent a reference to itself effectively shall also implement the Fn.Ref interface and return reasonable reference from the Fn.Ref.reference() method.

Since:

1.6.1

See Also:

Fn.ref(org.netbeans.html.boot.spi.Fn.Presenter)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Reference must properly implement Fn.Ref.hashCode() and Fn.Ref.equals(java.lang.Object).
int	hashCode() Reference must properly implement Fn.Ref.hashCode() and Fn.Ref.equals(java.lang.Object).
P	presenter() The associated presenter.
Fn.Ref<P>	reference() Creates a reference to a presenter.

Method Detail

reference

Fn.Ref<P> reference()

Creates a reference to a presenter. Rather than calling this method directly, call Fn.ref(org.netbeans.html.boot.spi.Fn.Presenter).

Returns:

a (weak) reference to the associated presenter

presenter

P presenter()

The associated presenter.

Returns:

the presenter or null, if it has been GCed meanwhile

hashCode

int hashCode()

Reference must properly implement Fn.Ref.hashCode() and Fn.Ref.equals(java.lang.Object).

Overrides:

hashCode in class java.lang.Object

Returns:

proper hashcode

equals

boolean equals(java.lang.Object obj)

Reference must properly implement Fn.Ref.hashCode() and Fn.Ref.equals(java.lang.Object).

Overrides:

equals in class java.lang.Object

Returns:

proper equals result