|
JML | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jmlspecs.models.JMLObjectToObjectRelation org.jmlspecs.models.JMLObjectToObjectMap
Maps (i.e., binary relations that are functional) from non-null
elements of Object
to non-null elements of Object
. The first type, Object, is called
the domain type of the map; the second type,
Object, is called the range type of the map. A
map can be seen as a set of pairs, of form (dv, rv),
consisting of an element of the domain type, dv, and an
element of the range type, rv. Alternatively, it can be
seen as a partial function that maps each element of the domain to
an element of the range type.
This type is a subtype of JMLObjectToObjectRelation
, and as such as can be treated as a
binary relation or a set valued function also. See the
documentation for JMLObjectToObjectRelation
and for the
methods inherited from this supertype for more information.
This type considers elements val and dv
of the domain type, to be distinct just when
_val_not_equal_to_dv_. It considers elements of
r and rv of the range type to be distinct
just when _r_not_equal_to_rv_. Cloning takes place for
the domain or range elements if the corresponding domain or range
type is JMLType
.
JMLCollection
,
JMLType
,
JMLObjectToObjectRelation
,
JMLObjectToObjectRelationEnumerator
,
JMLObjectToObjectRelationImageEnumerator
,
JMLValueSet
,
JMLObjectSet
,
JMLObjectToObjectMap
,
JMLValueToObjectMap
,
JMLObjectToValueMap
,
JMLValueToValueMap
,
JMLObjectToObjectRelation.toFunction()
Class Specifications |
public invariant this.isaFunction(); public invariant_redundantly ( \forall java.lang.Object dv; this.isDefinedAt(dv); this.elementImage(dv).int_size() == 1); |
Specifications inherited from class JMLObjectToObjectRelation |
public invariant ( \forall java.lang.Object obj; this.theRelation.has((org.jmlspecs.models.JMLType)obj); obj != null&&obj instanceof org.jmlspecs.models.JMLObjectObjectPair&&((org.jmlspecs.models.JMLObjectObjectPair)obj).key != null&&((org.jmlspecs.models.JMLObjectObjectPair)obj).value != null); public invariant_redundantly (* Every element of 'theRelation'is a JMLObjectObjectPair whose key and value are not null *); public invariant this.elementType == \type(org.jmlspecs.models.JMLObjectObjectPair); public invariant !this.containsNull; protected invariant this.imagePairSet_.int_size() == this.domain_.int_size()&&( \forall java.lang.Object dv; dv != null&&this.domain_.has(dv); this.imagePairSet_.has(new org.jmlspecs.models.JMLObjectValuePair(dv, this.elementImage(dv)))); protected invariant_redundantly this.imagePairSet_ == this.imagePairSet(); protected invariant this.size_ == this.theRelation.int_size(); protected invariant this.size_ >= 0; public invariant this.owner == null; protected represents theRelation <- this.toSet(); |
Specifications inherited from class Object |
represents objectState <- org.jmlspecs.lang.JMLDataGroup.IT; public represents _getClass <- \typeof(this); |
Specifications inherited from interface JMLCollection |
instance public constraint this.elementType == \old(this.elementType); instance public constraint this.containsNull == \old(this.containsNull); |
Model Field Summary |
Model fields inherited from class org.jmlspecs.models.JMLObjectToObjectRelation |
theRelation |
Model fields inherited from class java.lang.Object |
_getClass, objectState, theString |
Model fields inherited from interface org.jmlspecs.models.JMLCollection |
elementState |
Ghost Field Summary |
Ghost fields inherited from class java.lang.Object |
objectTimesFinalized, owner |
Ghost fields inherited from interface org.jmlspecs.models.JMLCollection |
containsNull, elementType |
Field Summary | |
static JMLObjectToObjectMap |
EMPTY
The empty JMLObjectToObjectMap. |
Fields inherited from class org.jmlspecs.models.JMLObjectToObjectRelation |
domain_, imagePairSet_, size_, TOO_BIG_TO_UNION |
Constructor Summary | |
|
JMLObjectToObjectMap()
Initialize this map to be the empty mapping. |
|
JMLObjectToObjectMap(non_null Object dv,
non_null Object rv)
Initialize this map to be a mapping that maps the given domain element to the given range element. |
|
JMLObjectToObjectMap(non_null JMLObjectObjectPair pair)
Initialize this map to be a mapping that maps the key in the given pair to the value in that pair. |
protected |
JMLObjectToObjectMap(JMLValueSet ipset,
JMLObjectSet dom,
int sz)
Initialize this map based on the representation values given. |
Model Method Summary |
Model methods inherited from class java.lang.Object |
hashValue |
Model methods inherited from interface org.jmlspecs.models.JMLCollection |
size |
Method Summary | |
Object |
apply(Object dv)
Return the range element corresponding to dv, if there is one. |
JMLObjectToObjectMap |
clashReplaceUnion(JMLObjectToObjectMap othMap,
Object errval)
Return a new map that is like the union of the given map and this map, except that if both define a mapping for a given domain element, then each of these clashes is replaced by a mapping from the domain element in question to the given range element. |
Object |
clone()
Return a clone of this object. |
JMLObjectToObjectMap |
compose(non_null JMLObjectToObjectMap othMap)
Return a new map that is the composition of this and the given map. |
JMLValueToObjectMap |
compose(non_null JMLValueToObjectMap othMap)
Return a new map that is the composition of this and the given map. |
JMLObjectToObjectMap |
disjointUnion(non_null JMLObjectToObjectMap othMap)
Return a map that is the disjoint union of this and othMap. |
JMLObjectToObjectMap |
extend(non_null Object dv,
non_null Object rv)
Return a new map that is like this but maps the given domain element to the given range element. |
JMLObjectToObjectMap |
extendUnion(non_null JMLObjectToObjectMap othMap)
Return a new map that is like the union of the given map and this map, except that if both define a mapping for a given domain element, then only the mapping in the given map is retained. |
boolean |
isaFunction()
Tells whether this relation is a function. |
JMLObjectToObjectMap |
rangeRestrictedTo(non_null JMLObjectSet rng)
Return a new map that is like this map but only contains associations that map to range elements in the given set. |
JMLObjectToObjectMap |
removeDomainElement(Object dv)
Return a new map that is like this but has no association for the given domain element. |
JMLObjectToObjectMap |
restrictedTo(non_null JMLObjectSet dom)
Return a new map that only maps elements in the given domain to the corresponding range elements in this map. |
static JMLObjectToObjectMap |
singletonMap(non_null Object dv,
non_null Object rv)
Return the singleton map containing the given association. |
static JMLObjectToObjectMap |
singletonMap(non_null JMLObjectObjectPair pair)
Return the singleton map containing the association described by the given pair. |
Methods inherited from class org.jmlspecs.models.JMLObjectToObjectRelation |
add, associations, compose, compose, difference, domain, domainElements, elementImage, elements, equals, has, has, has, hashCode, image, imagePairs, imagePairSet, insert, int_size, intersection, inverse, inverseElementImage, inverseImage, isDefinedAt, isEmpty, iterator, range, rangeElements, remove, remove, removeFromDomain, restrictDomainTo, restrictRangeTo, singleton, singleton, toBag, toFunction, toSequence, toSet, toString, union |
Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final JMLObjectToObjectMap EMPTY
JMLObjectToObjectMap()
Constructor Detail |
public JMLObjectToObjectMap()
EMPTY
public JMLObjectToObjectMap(non_null Object dv, non_null Object rv)
singletonMap(Object, Object)
,
JMLObjectToObjectMap(JMLObjectObjectPair)
public JMLObjectToObjectMap(non_null JMLObjectObjectPair pair)
singletonMap(JMLObjectObjectPair)
,
JMLObjectToObjectMap(Object, Object)
protected JMLObjectToObjectMap(JMLValueSet ipset, JMLObjectSet dom, int sz)
Method Detail |
public static JMLObjectToObjectMap singletonMap(non_null Object dv, non_null Object rv)
JMLObjectToObjectMap(Object, Object)
,
singletonMap(JMLObjectObjectPair)
public static JMLObjectToObjectMap singletonMap(non_null JMLObjectObjectPair pair)
JMLObjectToObjectMap(JMLObjectObjectPair)
,
singletonMap(Object, Object)
public boolean isaFunction()
isaFunction
in class JMLObjectToObjectRelation
public Object apply(Object dv) throws JMLNoSuchElementException
dv
- the domain element for which an association is
sought (the key to the table).
JMLNoSuchElementException
- when dv is not associated
to any range element by this.JMLObjectToObjectRelation.isDefinedAt(java.lang.Object)
,
JMLObjectToObjectRelation.elementImage(java.lang.Object)
,
JMLObjectToObjectRelation.image(org.jmlspecs.models.JMLObjectSet)
public Object clone()
JMLObjectToObjectRelation
clone
in interface JMLType
clone
in class JMLObjectToObjectRelation
public JMLObjectToObjectMap extend(non_null Object dv, non_null Object rv)
JMLObjectToObjectRelation#insert(Object, Object)
public JMLObjectToObjectMap removeDomainElement(Object dv)
JMLObjectToObjectRelation.removeFromDomain(java.lang.Object)
public JMLValueToObjectMap compose(non_null JMLValueToObjectMap othMap)
compose(JMLObjectToObjectMap)
public JMLObjectToObjectMap compose(non_null JMLObjectToObjectMap othMap)
compose(JMLValueToObjectMap)
public JMLObjectToObjectMap restrictedTo(non_null JMLObjectSet dom)
rangeRestrictedTo(org.jmlspecs.models.JMLObjectSet)
,
JMLObjectToObjectRelation.restrictDomainTo(org.jmlspecs.models.JMLObjectSet)
public JMLObjectToObjectMap rangeRestrictedTo(non_null JMLObjectSet rng)
restrictedTo(org.jmlspecs.models.JMLObjectSet)
,
JMLObjectToObjectRelation.restrictRangeTo(org.jmlspecs.models.JMLObjectSet)
public JMLObjectToObjectMap extendUnion(non_null JMLObjectToObjectMap othMap) throws IllegalStateException
IllegalStateException
clashReplaceUnion(org.jmlspecs.models.JMLObjectToObjectMap, java.lang.Object)
,
disjointUnion(org.jmlspecs.models.JMLObjectToObjectMap)
,
JMLObjectToObjectRelation.union(org.jmlspecs.models.JMLObjectToObjectRelation)
public JMLObjectToObjectMap clashReplaceUnion(JMLObjectToObjectMap othMap, Object errval) throws IllegalStateException
othMap
- the other map.errval
- the range element to use when clashes occur.
IllegalStateException
extendUnion(org.jmlspecs.models.JMLObjectToObjectMap)
,
disjointUnion(org.jmlspecs.models.JMLObjectToObjectMap)
,
JMLObjectToObjectRelation.union(org.jmlspecs.models.JMLObjectToObjectRelation)
public JMLObjectToObjectMap disjointUnion(non_null JMLObjectToObjectMap othMap) throws JMLMapException, IllegalStateException
othMap
- the other mapping
JMLMapException
- the ranges of this and othMap have elements
in common (i.e., when they interesect).
IllegalStateException
extendUnion(org.jmlspecs.models.JMLObjectToObjectMap)
,
clashReplaceUnion(org.jmlspecs.models.JMLObjectToObjectMap, java.lang.Object)
,
JMLObjectToObjectRelation.union(org.jmlspecs.models.JMLObjectToObjectRelation)
|
JML | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |