gnu.mapping

Class ConstrainedLocation<T>

java.lang.Object

gnu.mapping.Location<T>

gnu.mapping.ConstrainedLocation<T>

Direct Known Subclasses:

ReadOnlyLocation

public class ConstrainedLocation<T>
extends Location<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected Location<T>	base
protected Procedure	converter

Fields inherited from class gnu.mapping.Location

UNBOUND

Constructor Summary

Constructors

Constructor and Description
ConstrainedLocation()

Method Summary

Methods

Modifier and Type	Method and Description
protected T	coerce(T newValue)
T	get() Get the current value of this location.
T	get(T defaultValue)
java.lang.Object	getKeyProperty()
Symbol	getKeySymbol()
boolean	isBound()
boolean	isConstant()
static <T> ConstrainedLocation<T>	make(Location<T> base, Procedure converter)
void	set(T newValue)
void	setRestore(java.lang.Object oldValue) Restore an old value.
java.lang.Object	setWithSave(T newValue) Set a value, but return cookie so old value can be restored.
void	undefine()

Methods inherited from class gnu.mapping.Location

define, entered, getBase, getValue, make, make, make, print, setValue, toString

Methods inherited from class java.lang.Object

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

Field Detail

base

protected Location<T> base

converter

protected Procedure converter

Constructor Detail

ConstrainedLocation

public ConstrainedLocation()

Method Detail

make

public static <T> ConstrainedLocation<T> make(Location<T> base,
                              Procedure converter)

getKeySymbol

public Symbol getKeySymbol()

Overrides:

getKeySymbol in class Location<T>

getKeyProperty

public java.lang.Object getKeyProperty()

Overrides:

getKeyProperty in class Location<T>

isConstant

public boolean isConstant()

Overrides:

isConstant in class Location<T>

get

public final T get()

Description copied from class: Location

Get the current value of this location.

Specified by:

get in class Location<T>

get

public final T get(T defaultValue)

Overrides:

get in class Location<T>

isBound

public boolean isBound()

Specified by:

isBound in class Location<T>

coerce

protected T coerce(T newValue)

set

public final void set(T newValue)

Specified by:

set in class Location<T>

undefine

public void undefine()

Overrides:

undefine in class Location<T>

setWithSave

public java.lang.Object setWithSave(T newValue)

Description copied from class: Location

Set a value, but return cookie so old value can be restored. This is intended for fluid-let where (in the case of multiple threads) a simple save-restore isn't always the right thing.

Overrides:

setWithSave in class Location<T>

setRestore

public void setRestore(java.lang.Object oldValue)

Description copied from class: Location

Restore an old value.

Overrides:

setRestore in class Location<T>

Parameters:

oldValue - the return value from a prior setWithSave.