1 /*-
2 * #%L
3 * prolobjectlink-jpi
4 * %%
5 * Copyright (C) 2020 - 2021 Prolobjectlink Project
6 * %%
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 * THE SOFTWARE.
24 * #L%
25 */
26 package io.github.prolobjectlink.prolog;
27
28 import java.util.Collection;
29 import java.util.Map;
30
31 /**
32 * A PrologTerm that maps PrologTerm keys to PrologTerm values. A map cannot
33 * contain duplicate keys. Each key can map to at most one value.
34 *
35 * @author Jose Zalacain
36 * @since 1.1
37 */
38 public interface PrologMap extends PrologList, Map<PrologTerm, PrologTerm> {
39
40 /**
41 * Put all collections of entries in the map.
42 *
43 * @param entries entries to be put in the map.
44 * @since 1.1
45 */
46 public void putAll(Collection<Entry<PrologTerm, PrologTerm>> entries);
47
48 /**
49 * True if this map contains an entry previously created
50 *
51 * @return whether this map contains an entry previously created
52 * @since 1.1
53 */
54 public boolean contains(Entry<PrologTerm, PrologTerm> entry);
55
56 /**
57 * Remove in the map an entry previously created
58 *
59 * @param entry entry to be removed from this map
60 * @since 1.1
61 */
62 public void remove(Entry<PrologTerm, PrologTerm> entry);
63
64 /**
65 * Put in the map an entry previously created
66 *
67 * @param entry entry to be put in this map
68 * @since 1.1
69 */
70 public void put(Entry<PrologTerm, PrologTerm> entry);
71
72 }