xapi.util.api

Class Pointer<X>

java.lang.Object

xapi.util.api.Pointer<X>

Type Parameters:

X - - The type of X this pointer wraps.

All Implemented Interfaces:

Bean<X>, ProvidesValue<X>, ReceivesValue<X>

public final class Pointer<X>
extends Object
implements ProvidesValue<X>, ReceivesValue<X>, Bean<X>

This is not "actually" a pointer, but a hard Reference. Since that name is taken, we go with Pointer. :)

It implements ProvidesValue, ReceivesValue and Bean.

This class is final for compiler optimization; you should pass references as Bean if you want api compatibility, and Pointer if you want better inlining characteristics.

Author:

"James X. Nelson (james@wetheinter.net)"

Nested Class Summary

Nested classes/interfaces inherited from interface xapi.util.api.ReceivesValue

ReceivesValue.NoOp<T>

Constructor Summary

Constructors

Constructor and Description
Pointer()
Pointer(X x)

Method Summary

Methods

Modifier and Type	Method and Description
X	get()
X	remove()
void	set(X x) set() can be used either as an asynchronous method callback, or as an actual setter for a Bean value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Pointer

public Pointer()

Pointer

public Pointer(X x)

Method Detail

set

public final void set(X x)

Description copied from interface: ReceivesValue

set() can be used either as an asynchronous method callback, or as an actual setter for a Bean value.

Specified by:

set in interface ReceivesValue<X>

Parameters:

x - - The object to receive.

get

public final X get()

Specified by:

get in interface ProvidesValue<X>

Returns:

A value of type X whenever the owning object requests it.

remove

public final X remove()