All Implemented Interfaces:

EnvironmentKey, java.util.Map.Entry<EnvironmentKey,T>

Direct Known Subclasses:

AbstractScriptEngineFactory.BindingsLocation, DynamicLocation, PlainLocation, SharedLocation, ThreadLocation

public abstract class NamedLocation<T>
extends IndirectableLocation<T>
implements java.util.Map.Entry<EnvironmentKey,T>, EnvironmentKey 

• Field Summary

  • Fields inherited from class gnu.mapping.IndirectableLocation

    base, DIRECT_ON_SET, INDIRECT_FLUIDS, value

  • Fields inherited from class gnu.mapping.Location

    UNBOUND

  • Fields inherited from interface gnu.mapping.EnvironmentKey

    FUNCTION

• Constructor Summary

  Constructors

  Constructor and Description
  NamedLocation (NamedLocation loc)
  NamedLocation (Symbol name, java.lang.Object property)

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  boolean	entered () True if directly entered in an Environment.
  boolean	equals (java.lang.Object x)
  Environment	getEnvironment ()
  EnvironmentKey	getKey ()
  java.lang.Object	getKeyProperty ()
  Symbol	getKeySymbol ()
  int	hashCode ()
  boolean	matches (EnvironmentKey key)
  boolean	matches (Symbol symbol, java.lang.Object property)
  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.

  • Methods inherited from class gnu.mapping.IndirectableLocation

    getBase, getBaseForce, isConstant, setAlias, setBase, undefine

  • Methods inherited from class gnu.mapping.Location

    define, get, get, getValue, isBound, make, make, make, print, set, setValue, toString

  • Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Methods inherited from interface java.util.Map.Entry

    comparingByKey, comparingByKey, comparingByValue, comparingByValue, getValue, setValue

• Constructor Detail

  • NamedLocation

    public NamedLocation(NamedLocation loc)

  • NamedLocation

    public NamedLocation(Symbol name,
     java.lang.Object property)

• Method Detail

  • entered

    public boolean entered()

    Description copied from class: Location
    True if directly entered in an Environment. (Only if NamedLocation.)

    Overrides:

    entered in class Location<T>

  • getEnvironment

    public Environment getEnvironment()

    Overrides:

    getEnvironment in class IndirectableLocation<T>

  • getKeySymbol

    public final Symbol getKeySymbol()

    Specified by:

    getKeySymbol in interface EnvironmentKey

    Overrides:

    getKeySymbol in class IndirectableLocation<T>

  • getKeyProperty

    public final java.lang.Object getKeyProperty()

    Specified by:

    getKeyProperty in interface EnvironmentKey

    Overrides:

    getKeyProperty in class IndirectableLocation<T>

  • matches

    public final boolean matches(EnvironmentKey key)

    Specified by:

    matches in interface EnvironmentKey

  • matches

    public final boolean matches(Symbol symbol,
     java.lang.Object property)

    Specified by:

    matches in interface EnvironmentKey

  • getKey

    public final EnvironmentKey getKey()

    Specified by:

    getKey in interface java.util.Map.Entry<EnvironmentKey,T>

  • equals

    public boolean equals(java.lang.Object x)

    Specified by:

    equals in interface java.util.Map.Entry<EnvironmentKey,T>

    Overrides:

    equals in class java.lang.Object

  • hashCode

    public int hashCode()

    Specified by:

    hashCode in interface java.util.Map.Entry<EnvironmentKey,T>

    Overrides:

    hashCode in class java.lang.Object

  • 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.