aboutsummaryrefslogtreecommitdiffstats
path: root/lib/jinterface/java_src/com/ericsson/otp/erlang/OtpErlangMap.java
blob: 7f1a64b87d40190c0df318daad8326b0352358fe (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
/*
 * %CopyrightBegin%
 *
 * Copyright Ericsson AB 2000-2013. All Rights Reserved.
 *
 * The contents of this file are subject to the Erlang Public License,
 * Version 1.1, (the "License"); you may not use this file except in
 * compliance with the License. You should have received a copy of the
 * Erlang Public License along with this software. If not, it can be
 * retrieved online at http://www.erlang.org/.
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * %CopyrightEnd%
 */
package com.ericsson.otp.erlang;


/**
 * Provides a Java representation of Erlang maps. Maps are created from one or
 * more arbitrary Erlang terms.
 * 
 * <p>
 * The arity of the map is the number of elements it contains. The keys and
 * values can be retrieved as arrays and the value for a key can be queried.
 * 
 */
public class OtpErlangMap extends OtpErlangObject {
    // don't change this!
    private static final long serialVersionUID = -6410770117696198497L;

    private static final OtpErlangObject[] NO_ELEMENTS = new OtpErlangObject[0];

    private OtpErlangObject[] keys = NO_ELEMENTS;
    private OtpErlangObject[] values = NO_ELEMENTS;

    /**
     * Create a map from an array of keys and an array of values.
     * 
     * @param keys
     *            the array of terms to create the map keys from.
     * @param values
     *            the array of terms to create the map values from.
     * 
     * @exception java.lang.IllegalArgumentException
     *                if any array is empty (null) or contains null elements.
     */
    public OtpErlangMap(final OtpErlangObject[] keys,
	    final OtpErlangObject[] values) {
	this(keys, 0, keys.length, values, 0, values.length);
    }

    /**
     * Create a map from an array of terms.
     * 
     * @param keys
     *            the array of terms to create the map from.
     * @param kstart
     *            the offset of the first key to insert.
     * @param kcount
     *            the number of keys to insert.
     * @param values
     *            the array of values to create the map from.
     * @param vstart
     *            the offset of the first value to insert.
     * @param vcount
     *            the number of values to insert.
     * 
     * @exception java.lang.IllegalArgumentException
     *                if any array is empty (null) or contains null elements.
     * @exception java.lang.IllegalArgumentException
     *                if kcount and vcount differ.
     */
    public OtpErlangMap(final OtpErlangObject[] keys, final int kstart,
	    final int kcount, final OtpErlangObject[] values, final int vstart,
	    final int vcount) {
	if (keys == null || values == null) {
	    throw new java.lang.IllegalArgumentException(
		    "Map content can't be null");
	} else if (kcount != vcount) {
	    throw new java.lang.IllegalArgumentException(
		    "Map keys and values must have same arity");
	} else if (vcount < 1) {
	    this.keys = NO_ELEMENTS;
	    this.values = NO_ELEMENTS;
	} else {
	    this.keys = new OtpErlangObject[vcount];
	    for (int i = 0; i < vcount; i++) {
		if (keys[kstart + i] != null) {
		    this.keys[i] = keys[kstart + i];
		} else {
		    throw new java.lang.IllegalArgumentException(
			    "Map key cannot be null (element" + (kstart + i)
				    + ")");
		}
	    }
	    this.values = new OtpErlangObject[vcount];
	    for (int i = 0; i < vcount; i++) {
		if (values[vstart + i] != null) {
		    this.values[i] = values[vstart + i];
		} else {
		    throw new java.lang.IllegalArgumentException(
			    "Map value cannot be null (element" + (vstart + i)
				    + ")");
		}
	    }
	}
    }

    /**
     * Create a map from a stream containing a map encoded in Erlang external
     * format.
     * 
     * @param buf
     *            the stream containing the encoded map.
     * 
     * @exception OtpErlangDecodeException
     *                if the buffer does not contain a valid external
     *                representation of an Erlang map.
     */
    public OtpErlangMap(final OtpInputStream buf)
	    throws OtpErlangDecodeException {
	final int arity = buf.read_map_head();

	if (arity > 0) {
	    keys = new OtpErlangObject[arity];
	    values = new OtpErlangObject[arity];

	    for (int i = 0; i < arity; i++) {
		keys[i] = buf.read_any();
		values[i] = buf.read_any();
	    }
	} else {
	    keys = NO_ELEMENTS;
	    values = NO_ELEMENTS;
	}
    }

    /**
     * Get the arity of the map.
     * 
     * @return the number of elements contained in the map.
     */
    public int arity() {
	return keys.length;
    }

    /**
     * Get the specified value from the map.
     * 
     * @param key
     *            the key of the requested value.
     * 
     * @return the requested value, of null if key is not a valid key.
     */
    public OtpErlangObject get(final OtpErlangObject key) {
	if (key == null) {
	    return null;
	}
	for (int i = 0; i < keys.length; i++) {
	    if (key.equals(keys[i])) {
		return values[i];
	    }
	}
	return null;
    }

    /**
     * Get all the keys from the map as an array.
     * 
     * @return an array containing all of the map's keys.
     */
    public OtpErlangObject[] keys() {
	final OtpErlangObject[] res = new OtpErlangObject[arity()];
	System.arraycopy(keys, 0, res, 0, res.length);
	return res;
    }

    /**
     * Get all the values from the map as an array.
     * 
     * @return an array containing all of the map's values.
     */
    public OtpErlangObject[] values() {
	final OtpErlangObject[] res = new OtpErlangObject[arity()];
	System.arraycopy(values, 0, res, 0, res.length);
	return res;
    }

    /**
     * Get the string representation of the map.
     * 
     * @return the string representation of the map.
     */
    @Override
    public String toString() {
	int i;
	final StringBuffer s = new StringBuffer();
	final int arity = values.length;

	s.append("#{");

	for (i = 0; i < arity; i++) {
	    if (i > 0) {
		s.append(",");
	    }
	    s.append(keys[i].toString());
	    s.append(" => ");
	    s.append(values[i].toString());
	}

	s.append("}");

	return s.toString();
    }

    /**
     * Convert this map to the equivalent Erlang external representation.
     * 
     * @param buf
     *            an output stream to which the encoded map should be written.
     */
    @Override
    public void encode(final OtpOutputStream buf) {
	final int arity = values.length;

	buf.write_map_head(arity);

	for (int i = 0; i < arity; i++) {
	    buf.write_any(keys[i]);
	    buf.write_any(values[i]);
	}
    }

    /**
     * Determine if two maps are equal. Maps are equal if they have the same
     * arity and all of the elements are equal.
     * 
     * @param o
     *            the map to compare to.
     * 
     * @return true if the maps have the same arity and all the elements are
     *         equal.
     */
    @Override
    public boolean equals(final Object o) {
	if (!(o instanceof OtpErlangMap)) {
	    return false;
	}

	final OtpErlangMap t = (OtpErlangMap) o;
	final int a = arity();

	if (a != t.arity()) {
	    return false;
	}

	for (int i = 0; i < a; i++) {
	    if (!keys[i].equals(t.keys[i])) {
		return false; // early exit
	    }
	}
	for (int i = 0; i < a; i++) {
	    if (!values[i].equals(t.values[i])) {
		return false; // early exit
	    }
	}

	return true;
    }

    @Override
    protected int doHashCode() {
	final OtpErlangObject.Hash hash = new OtpErlangObject.Hash(9);
	final int a = arity();
	hash.combine(a);
	for (int i = 0; i < a; i++) {
	    hash.combine(keys[i].hashCode());
	}
	for (int i = 0; i < a; i++) {
	    hash.combine(values[i].hashCode());
	}
	return hash.valueOf();
    }

    @Override
    public Object clone() {
	final OtpErlangMap newMap = (OtpErlangMap) super.clone();
	newMap.values = values.clone();
	return newMap;
    }
}