| <html> | |
| <head> | |
| <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> | |
| <title>Map(K, V)</title> | |
| <link href="book.css" rel="stylesheet" type="text/css"> | |
| <meta content="DocBook XSL Stylesheets V1.75.1" name="generator"> | |
| <link rel="home" href="index.html" title="OCL Documentation"> | |
| <link rel="up" href="StandardLibrary.html" title="The OCL Standard Library"> | |
| <link rel="prev" href="Integer.html" title="Integer"> | |
| <link rel="next" href="OclAny.html" title="OclAny"> | |
| </head> | |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> | |
| <h1 xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0"> | |
| Map(K, V) | |
| </h1> | |
| <div class="section" title="Map(K, V)"> | |
| <div class="titlepage"> | |
| <div> | |
| <div> | |
| <h2 class="title" style="clear: both"> | |
| <a name="Map"></a> | |
| <span class="bold"><strong> | |
| <code class="code">Map(K, V)</code> | |
| </strong></span> | |
| </h2> | |
| </div> | |
| </div> | |
| </div> | |
| <p>A Map provides a Set of key values, each of which has an associated value. | |
| Keys and values may be null, but neither may be invalid.</p> | |
| <p>conformsTo | |
| <a class="link" href="OclAny.html" title="OclAny"> | |
| <code class="code">OclAny</code> | |
| </a> | |
| </p> | |
| <p> | |
| <span class="bold"><strong>Associations</strong></span> | |
| </p> | |
| <p> | |
| <code class="code">keyType : K[?]</code> | |
| </p> | |
| <p>The key type of the key-value pairs of | |
| <code class="code">self</code>. | |
| </p> | |
| <p> | |
| <code class="code">valueType : V[?]</code> | |
| </p> | |
| <p>The value type of the key-value pairs of | |
| <code class="code">self</code>. | |
| </p> | |
| <p> | |
| <span class="bold"><strong>Operations</strong></span> | |
| </p> | |
| <p> | |
| <code class="code">=(object2 : OclSelf[?]) : Boolean[1]</code> | |
| precedence: | |
| <code class="code">EQUALITY</code> | |
| </p> | |
| <p>Evaluates to | |
| <code class="code">true</code> if | |
| <code class="code">self</code> and s contain the same elements. | |
| </p> | |
| <p> | |
| <code class="code"><>(object2 : OclSelf[?]) : Boolean[1]</code> | |
| precedence: | |
| <code class="code">EQUALITY</code> | |
| </p> | |
| <p> | |
| <code class="code">at(key : OclAny[?]) : V[?] invalidating</code> | |
| </p> | |
| <p>The value of the map at | |
| <code class="code">key</code>. | |
| </p> | |
| <p> | |
| <code class="code">excludes(key : OclAny[?]) : Boolean[1]</code> | |
| </p> | |
| <p>True if | |
| <code class="code">key</code> is not one of the keys of | |
| <code class="code">self</code>, | |
| <code class="code">false</code> otherwise. | |
| </p> | |
| <p> | |
| <code class="code">excludes(key : OclAny[?], value : OclAny[?]) : Boolean[1]</code> | |
| </p> | |
| <p>True if | |
| <code class="code">key</code> and | |
| <code class="code">value</code> are not a key-value pair of | |
| <code class="code">self</code>, | |
| <code class="code">false</code> otherwise. | |
| </p> | |
| <p> | |
| <code class="code">excludesAll(K2)(coll : Collection(K2)) : Boolean[1]</code> | |
| </p> | |
| <p>True if none of the elements of | |
| <code class="code">coll</code> are keys of | |
| <code class="code">self</code>, | |
| <code class="code">false</code> otherwise. | |
| </p> | |
| <p> | |
| <code class="code">excludesMap(K2, V2)(map : Map(K2, V2)[?]) : Boolean[1]</code> | |
| </p> | |
| <p>True if none of the key-value pairs of | |
| <code class="code">map</code> are also key-value pairs of | |
| <code class="code">self</code>, | |
| <code class="code">false</code> otherwise. | |
| </p> | |
| <p> | |
| <code class="code">excludesValue(value : OclAny[?]) : Boolean[1]</code> | |
| </p> | |
| <p>True if | |
| <code class="code">value</code> is not one of the values of | |
| <code class="code">self</code>, | |
| <code class="code">false</code> otherwise. | |
| </p> | |
| <p> | |
| <code class="code">excluding(key : OclAny[?]) : Map(K, V)[?]</code> | |
| </p> | |
| <p>The map containing all key-value pairs of | |
| <code class="code">self</code> except any whose key is | |
| <code class="code">key</code>. | |
| </p> | |
| <p> | |
| <code class="code">excluding(key : OclAny[?], value : OclAny[?]) : Map(K, V)[?]</code> | |
| </p> | |
| <p>The map containing all key-value pairs of | |
| <code class="code">self</code> except any whose key is | |
| <code class="code">key</code> and whose value is | |
| <code class="code">key</code>. | |
| </p> | |
| <p> | |
| <code class="code">excludingAll(keys : Collection(OclAny)) : Map(K, V)[?]</code> | |
| </p> | |
| <p>The map containing all key-value pairs of | |
| <code class="code">self</code> except any whose key is included in | |
| <code class="code">keys</code>. | |
| </p> | |
| <p> | |
| <code class="code">excludingMap(K2, V2)(map : Map(K2, V2)[?]) : Map(K, V)[?]</code> | |
| </p> | |
| <p>The map containing all key-value pairs of | |
| <code class="code">self</code> except any which is also included in | |
| <code class="code">map</code>. | |
| </p> | |
| <p> | |
| <code class="code">includes(key : OclAny[?]) : Boolean[1]</code> | |
| </p> | |
| <p>True if | |
| <code class="code">key</code> is one of the keys of | |
| <code class="code">self</code>, | |
| <code class="code">false</code> otherwise. | |
| </p> | |
| <p> | |
| <code class="code">includes(key : OclAny[?], value : OclAny[?]) : Boolean[1]</code> | |
| </p> | |
| <p>True if | |
| <code class="code">key</code> and | |
| <code class="code">value</code> are a key-value pair of | |
| <code class="code">self</code>, | |
| <code class="code">false</code> otherwise. | |
| </p> | |
| <p> | |
| <code class="code">includesAll(K2)(coll : Collection(K2)) : Boolean[1]</code> | |
| </p> | |
| <p>True if all the elements of | |
| <code class="code">coll</code> are keys of | |
| <code class="code">self</code>, | |
| <code class="code">false</code> otherwise. | |
| </p> | |
| <p> | |
| <code class="code">includesMap(K2, V2)(map : Map(K2, V2)[?]) : Boolean[1]</code> | |
| </p> | |
| <p>True if all of the key-value pairs of | |
| <code class="code">map</code> are also key-value pairs of | |
| <code class="code">self</code>, | |
| <code class="code">false</code> otherwise. | |
| </p> | |
| <p> | |
| <code class="code">includesValue(value : OclAny[?]) : Boolean[1]</code> | |
| </p> | |
| <p>True if | |
| <code class="code">value</code> is one of the values of | |
| <code class="code">self</code>, | |
| <code class="code">false</code> otherwise. | |
| </p> | |
| <p> | |
| <code class="code">including(key : K[?], value : V[?]) : Map(K, V)[?]</code> | |
| </p> | |
| <p>The map containing all of the key-value pairs of | |
| <code class="code">self</code> and an additional key-value pair for | |
| <code class="code">key</code> and | |
| <code class="code">value</code>. | |
| If | |
| <code class="code">key</code> is already a key of | |
| <code class="code">self</code>, the old value pair is replaced by | |
| <code class="code">value</code>. | |
| </p> | |
| <p> | |
| <code class="code">includingMap(K2, V2)(map : Map(K2, V2)[?]) : Map(K, V)[?]</code> | |
| </p> | |
| <p>The map containing all of the key-value pairs of | |
| <code class="code">self</code> and | |
| <code class="code">map</code>. | |
| The values associated with key-value pairs in | |
| <code class="code">map</code> replace those in | |
| <code class="code">self</code> where the same key is used by both maps. | |
| </p> | |
| <p> | |
| <code class="code">isEmpty() : Boolean[1]</code> | |
| </p> | |
| <p>True if | |
| <code class="code">self</code> is the empty map, | |
| <code class="code">false</code> otherwise. | |
| </p> | |
| <p> | |
| <code class="code">keys() : Set(K)</code> | |
| </p> | |
| <p>A Set comprising all the keys of the key-value pairs in | |
| <code class="code">self</code>. | |
| </p> | |
| <p> | |
| <code class="code">notEmpty() : Boolean[1]</code> | |
| </p> | |
| <p>True if | |
| <code class="code">self</code> not the empty map, | |
| <code class="code">false</code> otherwise. | |
| </p> | |
| <p> | |
| <code class="code">size() : Integer[1]</code> | |
| </p> | |
| <p>The number of key-value pairs in | |
| <code class="code">self</code>. | |
| </p> | |
| <p> | |
| <code class="code">values() : Bag(V)</code> | |
| </p> | |
| <p>The Bag comprising all the values of the key-value pairs in | |
| <code class="code">self</code>. | |
| </p> | |
| </div> | |
| </body> | |
| </html> |