Subversion Repositories AndroidProjects

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
1107 chris 1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
<!-- NewPage -->
3
<html lang="en">
4
<head>
5
<!-- Generated by javadoc (version 1.7.0_17) on Sun Nov 03 15:35:43 CET 2013 -->
6
<title>MapProperties (libgdx API)</title>
7
<meta name="date" content="2013-11-03">
8
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
9
</head>
10
<body>
11
<script type="text/javascript"><!--
12
    if (location.href.indexOf('is-external=true') == -1) {
13
        parent.document.title="MapProperties (libgdx API)";
14
    }
15
//-->
16
</script>
17
<noscript>
18
<div>JavaScript is disabled on your browser.</div>
19
</noscript>
20
<!-- ========= START OF TOP NAVBAR ======= -->
21
<div class="topNav"><a name="navbar_top">
22
<!--   -->
23
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
24
<!--   -->
25
</a>
26
<ul class="navList" title="Navigation">
27
<li><a href="../../../../overview-summary.html">Overview</a></li>
28
<li><a href="package-summary.html">Package</a></li>
29
<li class="navBarCell1Rev">Class</li>
30
<li><a href="class-use/MapProperties.html">Use</a></li>
31
<li><a href="package-tree.html">Tree</a></li>
32
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
33
<li><a href="../../../../index-all.html">Index</a></li>
34
<li><a href="../../../../help-doc.html">Help</a></li>
35
</ul>
36
<div class="aboutLanguage"><em>
37
                                libgdx API
38
                                <style>
39
                                body, td, th { font-family:Helvetica, Tahoma, Arial, sans-serif; font-size:10pt }
40
                                pre, code, tt { font-size:9pt; font-family:Lucida Console, Courier New, sans-serif }
41
                                h1, h2, h3, .FrameTitleFont, .FrameHeadingFont, .TableHeadingColor font { font-size:105%;  font-weight:bold }
42
                                .TableHeadingColor { background:#EEEEFF; }
43
                                a { text-decoration:none }
44
                                a:hover { text-decoration:underline }
45
                                a:link, a:visited { color:blue }
46
                                table { border:0px }
47
                                .TableRowColor td:first-child { border-left:1px solid black }
48
                                .TableRowColor td { border:0px; border-bottom:1px solid black; border-right:1px solid black }
49
                                hr { border:0px; border-bottom:1px solid #333366; }
50
                                </style>
51
                        </em></div>
52
</div>
53
<div class="subNav">
54
<ul class="navList">
55
<li><a href="../../../../com/badlogic/gdx/maps/MapObjects.html" title="class in com.badlogic.gdx.maps"><span class="strong">Prev Class</span></a></li>
56
<li><a href="../../../../com/badlogic/gdx/maps/MapRenderer.html" title="interface in com.badlogic.gdx.maps"><span class="strong">Next Class</span></a></li>
57
</ul>
58
<ul class="navList">
59
<li><a href="../../../../index.html?com/badlogic/gdx/maps/MapProperties.html" target="_top">Frames</a></li>
60
<li><a href="MapProperties.html" target="_top">No Frames</a></li>
61
</ul>
62
<ul class="navList" id="allclasses_navbar_top">
63
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
64
</ul>
65
<div>
66
<script type="text/javascript"><!--
67
  allClassesLink = document.getElementById("allclasses_navbar_top");
68
  if(window==top) {
69
    allClassesLink.style.display = "block";
70
  }
71
  else {
72
    allClassesLink.style.display = "none";
73
  }
74
  //-->
75
</script>
76
</div>
77
<div>
78
<ul class="subNavList">
79
<li>Summary:&nbsp;</li>
80
<li>Nested&nbsp;|&nbsp;</li>
81
<li>Field&nbsp;|&nbsp;</li>
82
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
83
<li><a href="#method_summary">Method</a></li>
84
</ul>
85
<ul class="subNavList">
86
<li>Detail:&nbsp;</li>
87
<li>Field&nbsp;|&nbsp;</li>
88
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
89
<li><a href="#method_detail">Method</a></li>
90
</ul>
91
</div>
92
<a name="skip-navbar_top">
93
<!--   -->
94
</a></div>
95
<!-- ========= END OF TOP NAVBAR ========= -->
96
<!-- ======== START OF CLASS DATA ======== -->
97
<div class="header">
98
<div class="subTitle">com.badlogic.gdx.maps</div>
99
<h2 title="Class MapProperties" class="title">Class MapProperties</h2>
100
</div>
101
<div class="contentContainer">
102
<ul class="inheritance">
103
<li>java.lang.Object</li>
104
<li>
105
<ul class="inheritance">
106
<li>com.badlogic.gdx.maps.MapProperties</li>
107
</ul>
108
</li>
109
</ul>
110
<div class="description">
111
<ul class="blockList">
112
<li class="blockList">
113
<hr>
114
<br>
115
<pre>public class <span class="strong">MapProperties</span>
116
extends java.lang.Object</pre>
117
</li>
118
</ul>
119
</div>
120
<div class="summary">
121
<ul class="blockList">
122
<li class="blockList">
123
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
124
<ul class="blockList">
125
<li class="blockList"><a name="constructor_summary">
126
<!--   -->
127
</a>
128
<h3>Constructor Summary</h3>
129
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
130
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
131
<tr>
132
<th class="colOne" scope="col">Constructor and Description</th>
133
</tr>
134
<tr class="altColor">
135
<td class="colOne"><code><strong><a href="../../../../com/badlogic/gdx/maps/MapProperties.html#MapProperties()">MapProperties</a></strong>()</code>
136
<div class="block">Creates an empty properties set</div>
137
</td>
138
</tr>
139
</table>
140
</li>
141
</ul>
142
<!-- ========== METHOD SUMMARY =========== -->
143
<ul class="blockList">
144
<li class="blockList"><a name="method_summary">
145
<!--   -->
146
</a>
147
<h3>Method Summary</h3>
148
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
149
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
150
<tr>
151
<th class="colFirst" scope="col">Modifier and Type</th>
152
<th class="colLast" scope="col">Method and Description</th>
153
</tr>
154
<tr class="altColor">
155
<td class="colFirst"><code>void</code></td>
156
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/maps/MapProperties.html#clear()">clear</a></strong>()</code>
157
<div class="block">Removes all properties</div>
158
</td>
159
</tr>
160
<tr class="rowColor">
161
<td class="colFirst"><code>boolean</code></td>
162
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/maps/MapProperties.html#containsKey(java.lang.String)">containsKey</a></strong>(java.lang.String&nbsp;key)</code>&nbsp;</td>
163
</tr>
164
<tr class="altColor">
165
<td class="colFirst"><code>java.lang.Object</code></td>
166
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/maps/MapProperties.html#get(java.lang.String)">get</a></strong>(java.lang.String&nbsp;key)</code>&nbsp;</td>
167
</tr>
168
<tr class="rowColor">
169
<td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
170
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/maps/MapProperties.html#get(java.lang.String, java.lang.Class)">get</a></strong>(java.lang.String&nbsp;key,
171
   java.lang.Class&lt;T&gt;&nbsp;clazz)</code>
172
<div class="block">Returns the object for the given key, casting it to clazz.</div>
173
</td>
174
</tr>
175
<tr class="altColor">
176
<td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
177
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/maps/MapProperties.html#get(java.lang.String, T, java.lang.Class)">get</a></strong>(java.lang.String&nbsp;key,
178
   T&nbsp;defaultValue,
179
   java.lang.Class&lt;T&gt;&nbsp;clazz)</code>
180
<div class="block">Returns the object for the given key, casting it to clazz.</div>
181
</td>
182
</tr>
183
<tr class="rowColor">
184
<td class="colFirst"><code>java.util.Iterator&lt;java.lang.String&gt;</code></td>
185
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/maps/MapProperties.html#getKeys()">getKeys</a></strong>()</code>&nbsp;</td>
186
</tr>
187
<tr class="altColor">
188
<td class="colFirst"><code>java.util.Iterator&lt;java.lang.Object&gt;</code></td>
189
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/maps/MapProperties.html#getValues()">getValues</a></strong>()</code>&nbsp;</td>
190
</tr>
191
<tr class="rowColor">
192
<td class="colFirst"><code>void</code></td>
193
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/maps/MapProperties.html#put(java.lang.String, java.lang.Object)">put</a></strong>(java.lang.String&nbsp;key,
194
   java.lang.Object&nbsp;value)</code>&nbsp;</td>
195
</tr>
196
<tr class="altColor">
197
<td class="colFirst"><code>void</code></td>
198
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/maps/MapProperties.html#putAll(com.badlogic.gdx.maps.MapProperties)">putAll</a></strong>(<a href="../../../../com/badlogic/gdx/maps/MapProperties.html" title="class in com.badlogic.gdx.maps">MapProperties</a>&nbsp;properties)</code>&nbsp;</td>
199
</tr>
200
<tr class="rowColor">
201
<td class="colFirst"><code>void</code></td>
202
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/maps/MapProperties.html#remove(java.lang.String)">remove</a></strong>(java.lang.String&nbsp;key)</code>&nbsp;</td>
203
</tr>
204
</table>
205
<ul class="blockList">
206
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
207
<!--   -->
208
</a>
209
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
210
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
211
</ul>
212
</li>
213
</ul>
214
</li>
215
</ul>
216
</div>
217
<div class="details">
218
<ul class="blockList">
219
<li class="blockList">
220
<!-- ========= CONSTRUCTOR DETAIL ======== -->
221
<ul class="blockList">
222
<li class="blockList"><a name="constructor_detail">
223
<!--   -->
224
</a>
225
<h3>Constructor Detail</h3>
226
<a name="MapProperties()">
227
<!--   -->
228
</a>
229
<ul class="blockListLast">
230
<li class="blockList">
231
<h4>MapProperties</h4>
232
<pre>public&nbsp;MapProperties()</pre>
233
<div class="block">Creates an empty properties set</div>
234
</li>
235
</ul>
236
</li>
237
</ul>
238
<!-- ============ METHOD DETAIL ========== -->
239
<ul class="blockList">
240
<li class="blockList"><a name="method_detail">
241
<!--   -->
242
</a>
243
<h3>Method Detail</h3>
244
<a name="containsKey(java.lang.String)">
245
<!--   -->
246
</a>
247
<ul class="blockList">
248
<li class="blockList">
249
<h4>containsKey</h4>
250
<pre>public&nbsp;boolean&nbsp;containsKey(java.lang.String&nbsp;key)</pre>
251
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - property name</dd>
252
<dt><span class="strong">Returns:</span></dt><dd>true if and only if the property exists</dd></dl>
253
</li>
254
</ul>
255
<a name="get(java.lang.String)">
256
<!--   -->
257
</a>
258
<ul class="blockList">
259
<li class="blockList">
260
<h4>get</h4>
261
<pre>public&nbsp;java.lang.Object&nbsp;get(java.lang.String&nbsp;key)</pre>
262
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - property name</dd>
263
<dt><span class="strong">Returns:</span></dt><dd>the value for that property if it exists, otherwise, null</dd></dl>
264
</li>
265
</ul>
266
<a name="get(java.lang.String, java.lang.Class)">
267
<!--   -->
268
</a>
269
<ul class="blockList">
270
<li class="blockList">
271
<h4>get</h4>
272
<pre>public&nbsp;&lt;T&gt;&nbsp;T&nbsp;get(java.lang.String&nbsp;key,
273
        java.lang.Class&lt;T&gt;&nbsp;clazz)</pre>
274
<div class="block">Returns the object for the given key, casting it to clazz.</div>
275
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key of the object</dd><dd><code>clazz</code> - the class of the object</dd>
276
<dt><span class="strong">Returns:</span></dt><dd>the object or null if the object is not in the map</dd>
277
<dt><span class="strong">Throws:</span></dt>
278
<dd><code>java.lang.ClassCastException</code> - if the object with the given key is not of type clazz</dd></dl>
279
</li>
280
</ul>
281
<a name="get(java.lang.String,java.lang.Object,java.lang.Class)">
282
<!--   -->
283
</a><a name="get(java.lang.String, T, java.lang.Class)">
284
<!--   -->
285
</a>
286
<ul class="blockList">
287
<li class="blockList">
288
<h4>get</h4>
289
<pre>public&nbsp;&lt;T&gt;&nbsp;T&nbsp;get(java.lang.String&nbsp;key,
290
        T&nbsp;defaultValue,
291
        java.lang.Class&lt;T&gt;&nbsp;clazz)</pre>
292
<div class="block">Returns the object for the given key, casting it to clazz.</div>
293
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key of the object</dd><dd><code>defaultValue</code> - the default value</dd><dd><code>clazz</code> - the class of the object</dd>
294
<dt><span class="strong">Returns:</span></dt><dd>the object or the defaultValue if the object is not in the map</dd>
295
<dt><span class="strong">Throws:</span></dt>
296
<dd><code>java.lang.ClassCastException</code> - if the object with the given key is not of type clazz</dd></dl>
297
</li>
298
</ul>
299
<a name="put(java.lang.String, java.lang.Object)">
300
<!--   -->
301
</a>
302
<ul class="blockList">
303
<li class="blockList">
304
<h4>put</h4>
305
<pre>public&nbsp;void&nbsp;put(java.lang.String&nbsp;key,
306
       java.lang.Object&nbsp;value)</pre>
307
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - property name</dd><dd><code>value</code> - value to be inserted or modified (if it already existed)</dd></dl>
308
</li>
309
</ul>
310
<a name="putAll(com.badlogic.gdx.maps.MapProperties)">
311
<!--   -->
312
</a>
313
<ul class="blockList">
314
<li class="blockList">
315
<h4>putAll</h4>
316
<pre>public&nbsp;void&nbsp;putAll(<a href="../../../../com/badlogic/gdx/maps/MapProperties.html" title="class in com.badlogic.gdx.maps">MapProperties</a>&nbsp;properties)</pre>
317
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>properties</code> - set of properties to be added</dd></dl>
318
</li>
319
</ul>
320
<a name="remove(java.lang.String)">
321
<!--   -->
322
</a>
323
<ul class="blockList">
324
<li class="blockList">
325
<h4>remove</h4>
326
<pre>public&nbsp;void&nbsp;remove(java.lang.String&nbsp;key)</pre>
327
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - property name to be removed</dd></dl>
328
</li>
329
</ul>
330
<a name="clear()">
331
<!--   -->
332
</a>
333
<ul class="blockList">
334
<li class="blockList">
335
<h4>clear</h4>
336
<pre>public&nbsp;void&nbsp;clear()</pre>
337
<div class="block">Removes all properties</div>
338
</li>
339
</ul>
340
<a name="getKeys()">
341
<!--   -->
342
</a>
343
<ul class="blockList">
344
<li class="blockList">
345
<h4>getKeys</h4>
346
<pre>public&nbsp;java.util.Iterator&lt;java.lang.String&gt;&nbsp;getKeys()</pre>
347
<dl><dt><span class="strong">Returns:</span></dt><dd>iterator for the property names</dd></dl>
348
</li>
349
</ul>
350
<a name="getValues()">
351
<!--   -->
352
</a>
353
<ul class="blockListLast">
354
<li class="blockList">
355
<h4>getValues</h4>
356
<pre>public&nbsp;java.util.Iterator&lt;java.lang.Object&gt;&nbsp;getValues()</pre>
357
<dl><dt><span class="strong">Returns:</span></dt><dd>iterator to properties' values</dd></dl>
358
</li>
359
</ul>
360
</li>
361
</ul>
362
</li>
363
</ul>
364
</div>
365
</div>
366
<!-- ========= END OF CLASS DATA ========= -->
367
<!-- ======= START OF BOTTOM NAVBAR ====== -->
368
<div class="bottomNav"><a name="navbar_bottom">
369
<!--   -->
370
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
371
<!--   -->
372
</a>
373
<ul class="navList" title="Navigation">
374
<li><a href="../../../../overview-summary.html">Overview</a></li>
375
<li><a href="package-summary.html">Package</a></li>
376
<li class="navBarCell1Rev">Class</li>
377
<li><a href="class-use/MapProperties.html">Use</a></li>
378
<li><a href="package-tree.html">Tree</a></li>
379
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
380
<li><a href="../../../../index-all.html">Index</a></li>
381
<li><a href="../../../../help-doc.html">Help</a></li>
382
</ul>
383
<div class="aboutLanguage"><em>libgdx API</em></div>
384
</div>
385
<div class="subNav">
386
<ul class="navList">
387
<li><a href="../../../../com/badlogic/gdx/maps/MapObjects.html" title="class in com.badlogic.gdx.maps"><span class="strong">Prev Class</span></a></li>
388
<li><a href="../../../../com/badlogic/gdx/maps/MapRenderer.html" title="interface in com.badlogic.gdx.maps"><span class="strong">Next Class</span></a></li>
389
</ul>
390
<ul class="navList">
391
<li><a href="../../../../index.html?com/badlogic/gdx/maps/MapProperties.html" target="_top">Frames</a></li>
392
<li><a href="MapProperties.html" target="_top">No Frames</a></li>
393
</ul>
394
<ul class="navList" id="allclasses_navbar_bottom">
395
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
396
</ul>
397
<div>
398
<script type="text/javascript"><!--
399
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
400
  if(window==top) {
401
    allClassesLink.style.display = "block";
402
  }
403
  else {
404
    allClassesLink.style.display = "none";
405
  }
406
  //-->
407
</script>
408
</div>
409
<div>
410
<ul class="subNavList">
411
<li>Summary:&nbsp;</li>
412
<li>Nested&nbsp;|&nbsp;</li>
413
<li>Field&nbsp;|&nbsp;</li>
414
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
415
<li><a href="#method_summary">Method</a></li>
416
</ul>
417
<ul class="subNavList">
418
<li>Detail:&nbsp;</li>
419
<li>Field&nbsp;|&nbsp;</li>
420
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
421
<li><a href="#method_detail">Method</a></li>
422
</ul>
423
</div>
424
<a name="skip-navbar_bottom">
425
<!--   -->
426
</a></div>
427
<!-- ======== END OF BOTTOM NAVBAR ======= -->
428
<p class="legalCopy"><small>
429
                                <div style="font-size:9pt"><i>
430
                                Copyright &copy; 2010-2013 Mario Zechner (contact@badlogicgames.com), Nathan Sweet (admin@esotericsoftware.com)
431
                                </i></div>
432
                        </small></p>
433
</body>
434
</html>