org.dellroad.querystream.jpa

Class FromRef<X>

java.lang.Object

org.dellroad.querystream.jpa.FromRef<X>

Type Parameters:

X - stream item type

All Implemented Interfaces:

Ref<X,From<?,X>>

public class FromRef<X>
extends Object

A Ref that's known to be a From.

Constructor Summary

Constructors

Constructor and Description
FromRef() Create an instance with no name.
FromRef(String name) Create an instance with the given name.

Method Summary

Modifier and Type	Method and Description
S	bind(S value) Bind the given value to this reference.
S	get() Get the bound value.
boolean	isBound() Determine if this instance is bound.
String	toString()
void	unbind() Unbind the bound value, if any.

Methods inherited from class java.lang.Object

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

Constructor Detail

FromRef

public FromRef()

Create an instance with no name.

FromRef

public FromRef(String name)

Create an instance with the given name.

The name is only used for debugging purposes.

Parameters:

name - reference name, or null for none

Method Detail

bind

public S bind(S value)

Description copied from interface: Ref

Bind the given value to this reference.

Specified by:

bind in interface Ref<X,S extends Selection<X>>

Parameters:

value - value to bind

Returns:

same value

get

public S get()

Description copied from interface: Ref

Get the bound value.

Specified by:

get in interface Ref<X,S extends Selection<X>>

Returns:

bound value

unbind

public void unbind()

Description copied from interface: Ref

Unbind the bound value, if any.

Specified by:

unbind in interface Ref<X,S extends Selection<X>>

isBound

public boolean isBound()

Description copied from interface: Ref

Determine if this instance is bound.

Specified by:

isBound in interface Ref<X,S extends Selection<X>>

Returns:

true if this instance is bound, otherwise false

toString

public String toString()

Overrides:

toString in class Object