y25.base
Interface LayerEdgeMap

All Superinterfaces:
DataAcceptor, DataProvider
All Known Implementing Classes:
LayeredGraph.LayerEdgeMapImpl

public interface LayerEdgeMap
extends DataProvider, DataAcceptor

Provides access to data associated with a layer edge. A layer edge map can be considered as a map that allows only layer edges as keys. The layer edges used as keys for the getter/setter methods must belong to the same layered graph.

The values bound to the layer edges are initialized with Java(TM) default values(null, 0, 0.0, false) upon initialization.


Method Summary
 Object get(Object layerEdge)
          Returns the value bound to the given layer edge.
 boolean getBool(Object layerEdge)
          Returns the boolean value bound to the given layer edge.
 double getDouble(Object layerEdge)
          Returns the double value bound to the given layer edge.
 int getInt(Object layerEdge)
          Returns the integer value bound to the given layer edge.
 Object remove(Object layerEdge)
          Removes the value stored for the given layer edge, if present.
 void set(Object layerEdge, Object value)
          Associates the given value to the given layer edge.
 void setBool(Object layerEdge, boolean value)
          Associates the given boolean value to the given layer edge.
 void setDouble(Object layerEdge, double value)
          Associates the given double value to the given layer edge.
 void setInt(Object layerEdge, int value)
          Associates the given integer value to the given layer edge.
 

Method Detail

remove

public Object remove(Object layerEdge)
Removes the value stored for the given layer edge, if present. Returns the value that was previously stored for the layer edge, or null if there was no mapping for that layer edge. A null return can also mean that the map previously associated null with the given layer edge.


get

public Object get(Object layerEdge)
Returns the value bound to the given layer edge. The value must have been assiciated to the given layer edge by a call to set.

Returns null if the map contains no mapping for this key. A return value of null does not necessarily indicate that the map contains no mapping for the key; it is also possible that the map explicitly maps the key to null.

Specified by:
get in interface DataProvider

getBool

public boolean getBool(Object layerEdge)
Returns the boolean value bound to the given layer edge. The value must have been assiciated to the given layer edge by a call to setBool.

Returns false if the map contains no mapping for this key. A return value of false does not necessarily indicate that the map contains no mapping for the key; it is also possible that the map explicitly maps the key to false.

Specified by:
getBool in interface DataProvider

getDouble

public double getDouble(Object layerEdge)
Returns the double value bound to the given layer edge. The value must have been assiciated to the given layer edge by a call to setDouble.

Returns 0.0 if the map contains no mapping for this key. A return value of 0.0 does not necessarily indicate that the map contains no mapping for the key; it is also possible that the map explicitly maps the key to 0.0.

Specified by:
getDouble in interface DataProvider

getInt

public int getInt(Object layerEdge)
Returns the integer value bound to the given layer edge. The value must have been assiciated to the given layer edge by a call to setInt.

Returns 0 if the map contains no mapping for this key. A return value of 0 does not necessarily indicate that the map contains no mapping for the key; it is also possible that the map explicitly maps the key to 0.

Specified by:
getInt in interface DataProvider

set

public void set(Object layerEdge,
                Object value)
Associates the given value to the given layer edge.

Specified by:
set in interface DataAcceptor

setBool

public void setBool(Object layerEdge,
                    boolean value)
Associates the given boolean value to the given layer edge.

Specified by:
setBool in interface DataAcceptor

setDouble

public void setDouble(Object layerEdge,
                      double value)
Associates the given double value to the given layer edge.

Specified by:
setDouble in interface DataAcceptor

setInt

public void setInt(Object layerEdge,
                   int value)
Associates the given integer value to the given layer edge.

Specified by:
setInt in interface DataAcceptor