annotate src/main/java/cl/maps/duplex/IDuplexMap.java @ 127:3e772f7f43e0 default tip

ismi-date with long month names in xml dump.
author Robert Casties <casties@mpiwg-berlin.mpg.de>
date Thu, 11 May 2023 18:15:45 +0200
parents 6e08ff123ae6
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
59
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
1 package cl.maps.duplex;
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
2
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
3 import java.util.Collection;
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
4 import java.util.Map;
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
5 import java.util.Set;
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
6
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
7 import cl.maps.quad.QuadKey;
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
8
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
9 public interface IDuplexMap<V, A, B> {
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
10
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
11 int size();
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
12
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
13 boolean isEmpty();
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
14
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
15 boolean containsKey(DuplexKey<A, B> key);
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
16
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
17 boolean containsValue(Object value);
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
18
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
19 V get(DuplexKey<A, B> key);
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
20
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
21 V put(DuplexKey<A, B> key, V value);
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
22
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
23 V remove(DuplexKey<A, B> key);
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
24
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
25 //void putAll(Map<? extends K, ? extends V> m);
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
26
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
27 void clear();
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
28
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
29 Set<DuplexKey<A, B>> keySet();
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
30
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
31 Collection<V> values();
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
32
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
33 Set<Map.Entry<DuplexKey<A, B>, V>> entrySet();
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
34
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
35 boolean equals(Object o);
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
36
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
37 /**
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
38 * Returns the hash code value for this map. The hash code of a map is
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
39 * defined to be the sum of the hash codes of each entry in the map's
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
40 * <tt>entrySet()</tt> view. This ensures that <tt>m1.equals(m2)</tt>
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
41 * implies that <tt>m1.hashCode()==m2.hashCode()</tt> for any two maps
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
42 * <tt>m1</tt> and <tt>m2</tt>, as required by the general contract of
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
43 * {@link Object#hashCode}.
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
44 *
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
45 * @return the hash code value for this map
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
46 * @see Map.Entry#hashCode()
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
47 * @see Object#equals(Object)
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
48 * @see #equals(Object)
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
49 */
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
50 int hashCode();
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
51
6e08ff123ae6 check in complete source of cl.maps.
casties
parents:
diff changeset
52 }