clem
/
SquidLib


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571
							<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SquidStorage (squidlib-extra 3.0.0-SNAPSHOT)</title>
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="SquidStorage (squidlib-extra 3.0.0-SNAPSHOT)";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../squidpony/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SquidStorage.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-files/index-1.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../index.html?squidpony/SquidStorage.html" target="_top">Frames</a></li>
<li><a href="SquidStorage.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">squidpony</div>
<h2 title="Class SquidStorage" class="title">Class SquidStorage</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>squidpony.SquidStorage</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@Beta
public class <a href="../src-html/squidpony/SquidStorage.html#line.22">SquidStorage</a>
extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Helps games store information in libGDX's Preferences class as Strings, then get it back out.
 Created by Tommy Ettinger on 9/16/2016.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!--   -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../squidpony/SquidStorage.html#compress">compress</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected squidpony.squidmath.OrderedMap&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../squidpony/SquidStorage.html#contents">contents</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>com.badlogic.gdx.utils.Json</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../squidpony/SquidStorage.html#json">json</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>com.badlogic.gdx.Preferences</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../squidpony/SquidStorage.html#preferences">preferences</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../squidpony/SquidStorage.html#storageName">storageName</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../squidpony/SquidStorage.html#SquidStorage--">SquidStorage</a></span>()</code>
<div class="block">Please don't use this constructor if possible; it simply calls <a href="../squidpony/SquidStorage.html#SquidStorage-java.lang.String-"><code>SquidStorage(String)</code></a> with the constant
 String "nameless".</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../squidpony/SquidStorage.html#SquidStorage-java.lang.String-">SquidStorage</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fileName)</code>
<div class="block">Creates a SquidStorage with the given fileName to save using Preferences from libGDX.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../squidpony/SquidStorage.html" title="class in squidpony">SquidStorage</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../squidpony/SquidStorage.html#clear--">clear</a></span>()</code>
<div class="block">Clears the current group of objects; recommended if you intend to store under multiple outerName keys.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../squidpony/SquidStorage.html#get-java.lang.String-java.lang.String-java.lang.Class-">get</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;outerName,
   <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;innerName,
   <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;type)</code>
<div class="block">Gets an object from the storage by the given <code>outerName</code> key from <a href="../squidpony/SquidStorage.html#store-java.lang.String-"><code>store(String)</code></a> and
 <code>innerName</code> key from <a href="../squidpony/SquidStorage.html#put-java.lang.String-java.lang.Object-"><code>put(String, Object)</code></a>, and uses the class given by <code>type</code> for the
 returned value, assuming it matches the object that was originally put with those keys.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../squidpony/SquidStorage.html#preferencesSize--">preferencesSize</a></span>()</code>
<div class="block">Gets the approximate size of the currently-stored preferences.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../squidpony/SquidStorage.html" title="class in squidpony">SquidStorage</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../squidpony/SquidStorage.html#put-java.lang.String-java.lang.Object-">put</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;innerName,
   <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;o)</code>
<div class="block">Prepares to store the Object <code>o</code> to be retrieved with <code>innerName</code> in the current group of objects.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../squidpony/SquidStorage.html" title="class in squidpony">SquidStorage</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../squidpony/SquidStorage.html#remove-java.lang.String-">remove</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;innerName)</code>
<div class="block">Removes one object from the current group by the <code>innerName</code> it was prepared with using
 <a href="../squidpony/SquidStorage.html#put-java.lang.String-java.lang.Object-"><code>put(String, Object)</code></a>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../squidpony/SquidStorage.html#show--">show</a></span>()</code>
<div class="block">Gets a String representation of the data that would be saved when <a href="../squidpony/SquidStorage.html#store-java.lang.String-"><code>store(String)</code></a> is called.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../squidpony/SquidStorage.html" title="class in squidpony">SquidStorage</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../squidpony/SquidStorage.html#store-java.lang.String-">store</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;outerName)</code>
<div class="block">Actually stores all objects that had previously been prepared with <a href="../squidpony/SquidStorage.html#put-java.lang.String-java.lang.Object-"><code>put(String, Object)</code></a>, with
 <code>outerName</code> used as a key to retrieve any object in the current group.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!--   -->
</a>
<h3>Field Detail</h3>
<a name="preferences">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>preferences</h4>
<pre>public final&nbsp;com.badlogic.gdx.Preferences <a href="../src-html/squidpony/SquidStorage.html#line.23">preferences</a></pre>
</li>
</ul>
<a name="storageName">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>storageName</h4>
<pre>public final&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../src-html/squidpony/SquidStorage.html#line.24">storageName</a></pre>
</li>
</ul>
<a name="json">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>json</h4>
<pre>public final&nbsp;com.badlogic.gdx.utils.Json <a href="../src-html/squidpony/SquidStorage.html#line.25">json</a></pre>
</li>
</ul>
<a name="contents">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contents</h4>
<pre>protected&nbsp;squidpony.squidmath.OrderedMap&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt; <a href="../src-html/squidpony/SquidStorage.html#line.26">contents</a></pre>
</li>
</ul>
<a name="compress">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>compress</h4>
<pre>public&nbsp;boolean <a href="../src-html/squidpony/SquidStorage.html#line.27">compress</a></pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="SquidStorage--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SquidStorage</h4>
<pre>public&nbsp;<a href="../src-html/squidpony/SquidStorage.html#line.35">SquidStorage</a>()</pre>
<div class="block">Please don't use this constructor if possible; it simply calls <a href="../squidpony/SquidStorage.html#SquidStorage-java.lang.String-"><code>SquidStorage(String)</code></a> with the constant
 String "nameless". This could easily overlap with other files/sections in Preferences, so you should always
 prefer giving a String argument to the constructor, typically the name of the game.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../squidpony/SquidStorage.html#SquidStorage-java.lang.String-"><code>the recommended constructor to use</code></a></dd>
</dl>
</li>
</ul>
<a name="SquidStorage-java.lang.String-">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SquidStorage</h4>
<pre>public&nbsp;<a href="../src-html/squidpony/SquidStorage.html#line.59">SquidStorage</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fileName)</pre>
<div class="block">Creates a SquidStorage with the given fileName to save using Preferences from libGDX. The name should generally
 be the name of this game or application, and must be a valid name for a file (so no slashes, backslashes, colons,
 semicolons, or commas for certain, and other non-alphanumeric characters are also probably invalid). You should
 not assume anything is present in the Preferences storage unless you have put it there, and this applies doubly
 to games or applications other than your own; you should avoid values for fileName that might overlap with
 another game's Preferences values.
 <br>
 To organize saved data into sub-sections, you specify logical units (like different players' saved games) with a
 String outerName when you call <a href="../squidpony/SquidStorage.html#store-java.lang.String-"><code>store(String)</code></a>, and can further distinguish data under the outerName when
 you call <a href="../squidpony/SquidStorage.html#put-java.lang.String-java.lang.Object-"><code>put(String, Object)</code></a> to put each individual item into the saved storage with its own innerName.
 <br>
 Calling this also sets up custom serializers for several important types in SquidLib; char[][], OrderedMap,
 IntDoubleOrderedMap, FakeLanguageGen, GreasedRegion, and notably Pattern from RegExodus all have smaller
 serialized representations than the default. OrderedMap allows non-String keys, which gets around a limitation in
 JSON maps normally, and both FakeLanguageGen and Pattern are amazingly smaller with the custom representation.
 The custom char[][] representation is about half the normal size by omitting commas after each char.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fileName</code> - the valid file name to create or open from Preferences; typically the name of the game/app.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="put-java.lang.String-java.lang.Object-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>public&nbsp;<a href="../squidpony/SquidStorage.html" title="class in squidpony">SquidStorage</a>&nbsp;<a href="../src-html/squidpony/SquidStorage.html#line.337">put</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;innerName,
                        <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;o)</pre>
<div class="block">Prepares to store the Object <code>o</code> to be retrieved with <code>innerName</code> in the current group of objects.
 Does not write to a permanent location until <a href="../squidpony/SquidStorage.html#store-java.lang.String-"><code>store(String)</code></a> is called. The innerName used to store an
 object is required to get it back again, and can also be used to remove it before storing (or storing again).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>innerName</code> - one of the two Strings needed to retrieve this later</dd>
<dd><code>o</code> - the Object to prepare to store</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this for chaining</dd>
</dl>
</li>
</ul>
<a name="store-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>store</h4>
<pre>public&nbsp;<a href="../squidpony/SquidStorage.html" title="class in squidpony">SquidStorage</a>&nbsp;<a href="../src-html/squidpony/SquidStorage.html#line.353">store</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;outerName)</pre>
<div class="block">Actually stores all objects that had previously been prepared with <a href="../squidpony/SquidStorage.html#put-java.lang.String-java.lang.Object-"><code>put(String, Object)</code></a>, with
 <code>outerName</code> used as a key to retrieve any object in the current group. Flushes the preferences, making the
 changes permanent (until overwritten), but does not change the current group (you may want to call this method
 again with additional items in the current group, and that would simply involve calling put() again). If you want
 to clear the current group, use <a href="../squidpony/SquidStorage.html#clear--"><code>clear()</code></a>. If you want to remove just one object from the current group,
 use <a href="../squidpony/SquidStorage.html#remove-java.lang.String-"><code>remove(String)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>outerName</code> - one of the two Strings needed to retrieve any of the objects in the current group</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this for chaining</dd>
</dl>
</li>
</ul>
<a name="show--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>show</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../src-html/squidpony/SquidStorage.html#line.368">show</a>()</pre>
<div class="block">Gets a String representation of the data that would be saved when <a href="../squidpony/SquidStorage.html#store-java.lang.String-"><code>store(String)</code></a> is called. This can be
 useful for finding particularly problematic objects that require unnecessary space when serialized.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a String that previews what would be stored permanently when <a href="../squidpony/SquidStorage.html#store-java.lang.String-"><code>store(String)</code></a> is called</dd>
</dl>
</li>
</ul>
<a name="clear--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre>public&nbsp;<a href="../squidpony/SquidStorage.html" title="class in squidpony">SquidStorage</a>&nbsp;<a href="../src-html/squidpony/SquidStorage.html#line.380">clear</a>()</pre>
<div class="block">Clears the current group of objects; recommended if you intend to store under multiple outerName keys.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this for chaining</dd>
</dl>
</li>
</ul>
<a name="remove-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>public&nbsp;<a href="../squidpony/SquidStorage.html" title="class in squidpony">SquidStorage</a>&nbsp;<a href="../src-html/squidpony/SquidStorage.html#line.393">remove</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;innerName)</pre>
<div class="block">Removes one object from the current group by the <code>innerName</code> it was prepared with using
 <a href="../squidpony/SquidStorage.html#put-java.lang.String-java.lang.Object-"><code>put(String, Object)</code></a>. This does not affect already-stored objects unless <a href="../squidpony/SquidStorage.html#store-java.lang.String-"><code>store(String)</code></a> is called
 after this, in which case the new version of the current group, without the object this removed, is stored.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>innerName</code> - the String key used to put an object in the current group with <a href="../squidpony/SquidStorage.html#put-java.lang.String-java.lang.Object-"><code>put(String, Object)</code></a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this for chaining</dd>
</dl>
</li>
</ul>
<a name="get-java.lang.String-java.lang.String-java.lang.Class-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public&nbsp;&lt;T&gt;&nbsp;T&nbsp;<a href="../src-html/squidpony/SquidStorage.html#line.411">get</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;outerName,
                 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;innerName,
                 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;type)</pre>
<div class="block">Gets an object from the storage by the given <code>outerName</code> key from <a href="../squidpony/SquidStorage.html#store-java.lang.String-"><code>store(String)</code></a> and
 <code>innerName</code> key from <a href="../squidpony/SquidStorage.html#put-java.lang.String-java.lang.Object-"><code>put(String, Object)</code></a>, and uses the class given by <code>type</code> for the
 returned value, assuming it matches the object that was originally put with those keys. If no such object is
 present, returns null. Results are undefined if <code>type</code> doesn't match the actual class of the stored object.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - the type of the value to retrieve; if type was <code>RNG.class</code>, this would be <code>RNG</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>outerName</code> - the key used to store the group of objects with <a href="../squidpony/SquidStorage.html#store-java.lang.String-"><code>store(String)</code></a></dd>
<dd><code>innerName</code> - the key used to store the specific object with <a href="../squidpony/SquidStorage.html#put-java.lang.String-java.lang.Object-"><code>put(String, Object)</code></a></dd>
<dd><code>type</code> - the class of the value; for a class like RNG, use <code>RNG.class</code>, but changed to fit</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the retrieved value if successful, or null otherwise</dd>
</dl>
</li>
</ul>
<a name="preferencesSize--">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>preferencesSize</h4>
<pre>public&nbsp;int&nbsp;<a href="../src-html/squidpony/SquidStorage.html#line.432">preferencesSize</a>()</pre>
<div class="block">Gets the approximate size of the currently-stored preferences. This assumes UTF-16 storage, which is the case for
 GWT's LocalStorage. Since GWT is restricted to the size the browser permits for LocalStorage, and this limit can
 be rather small (about 5 MB, sometimes more but not reliably), this method is especially useful there, but it may
 yield inaccurate sizes on other platforms that save Preferences data differently.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the size, in bytes, of the already-stored preferences</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../squidpony/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SquidStorage.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-files/index-1.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../index.html?squidpony/SquidStorage.html" target="_top">Frames</a></li>
<li><a href="SquidStorage.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2016. All rights reserved.</small></p>
</body>
</html>