AfflictionNetworks/vilya
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
907eaa7014cde93e994514299f845079dafc5ad4
vilya/apidocs/com/threerings/stats/data/Stat.html
T
Michael Bayne 907eaa7014 Updated docs for 1.6 release.
2015-03-14 10:44:30 -07:00

579 lines
29 KiB
HTML
Raw Blame History

<!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 (1.8.0_31) on Sat Mar 14 10:07:12 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Stat (Vilya Core 1.6 API)</title>
<meta name="date" content="2015-03-14">
<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="Stat (Vilya Core 1.6 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":9,"i7":9,"i8":10,"i9":6,"i10":10,"i11":10,"i12":10,"i13":6,"i14":6};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Stat.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-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/threerings/stats/data/ShortStringSetStat.html" title="class in com.threerings.stats.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/threerings/stats/data/Stat.AuxDataSource.html" title="interface in com.threerings.stats.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/threerings/stats/data/Stat.html" target="_top">Frames</a></li>
<li><a href="Stat.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&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>Field&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">com.threerings.stats.data</div>
<h2 title="Class Stat" class="title">Class Stat</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/1.5.0/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>com.threerings.stats.data.Stat</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>com.threerings.io.Streamable, com.threerings.presents.dobj.DSet.Entry, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../com/threerings/stats/data/IntArrayStat.html" title="class in com.threerings.stats.data">IntArrayStat</a>, <a href="../../../../com/threerings/stats/data/IntStat.html" title="class in com.threerings.stats.data">IntStat</a>, <a href="../../../../com/threerings/stats/data/SetStat.html" title="class in com.threerings.stats.data">SetStat</a>, <a href="../../../../com/threerings/stats/data/StringMapStat.html" title="class in com.threerings.stats.data">StringMapStat</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">Stat</span>
extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements com.threerings.presents.dobj.DSet.Entry, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></pre>
<div class="block">A base class for persistent statistics tracked on a per-player basis (some for a single game,
others for all time).</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/stats/data/Stat.AuxDataSource.html" title="interface in com.threerings.stats.data">Stat.AuxDataSource</a></span></code>
<div class="block">Provides auxilliary information to statistics during the persisting process.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/stats/data/Stat.Type.html" title="interface in com.threerings.stats.data">Stat.Type</a></span></code>
<div class="block">Defines the various per-player tracked statistics.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.com.threerings.io.Streamable">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;com.threerings.io.Streamable</h3>
<code>com.threerings.io.Streamable.Closure</code></li>
</ul>
</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="../../../../com/threerings/stats/data/Stat.html#Stat--">Stat</a></span>()</code>&nbsp;</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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="../../../../com/threerings/stats/data/Stat.html" title="class in com.threerings.stats.data">Stat</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/stats/data/Stat.html#clone--">clone</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/stats/data/Stat.html#crc32-java.lang.String-">crc32</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;string)</code>
<div class="block">Computes and returns the CRC32 hash of the specified string.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/stats/data/Stat.html#getCode--">getCode</a></span>()</code>
<div class="block">Returns the integer code to which this statistic's name maps.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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="../../../../com/threerings/stats/data/Stat.html#getKey--">getKey</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>byte</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/stats/data/Stat.html#getModCount--">getModCount</a></span>()</code>
<div class="block">Returns the modification count of this Stat when it was loaded from the repository.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/threerings/stats/data/Stat.Type.html" title="interface in com.threerings.stats.data">Stat.Type</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/stats/data/Stat.html#getType--">getType</a></span>()</code>
<div class="block">Returns the type of this statistic.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="../../../../com/threerings/stats/data/Stat.Type.html" title="interface in com.threerings.stats.data">Stat.Type</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/stats/data/Stat.html#getType-int-">getType</a></span>(int&nbsp;code)</code>
<div class="block">Maps a <a href="../../../../com/threerings/stats/data/Stat.Type.html" title="interface in com.threerings.stats.data"><code>Stat.Type</code></a>'s code code back to a <a href="../../../../com/threerings/stats/data/Stat.Type.html" title="interface in com.threerings.stats.data"><code>Stat.Type</code></a> instance.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/stats/data/Stat.html#initType-com.threerings.stats.data.Stat.Type-com.threerings.stats.data.Stat-">initType</a></span>(<a href="../../../../com/threerings/stats/data/Stat.Type.html" title="interface in com.threerings.stats.data">Stat.Type</a>&nbsp;type,
<a href="../../../../com/threerings/stats/data/Stat.html" title="class in com.threerings.stats.data">Stat</a>&nbsp;prototype)</code>
<div class="block">Used by the <a href="../../../../com/threerings/stats/data/Stat.Type.html" title="interface in com.threerings.stats.data"><code>Stat.Type</code></a> implementation to map itself to an integer code.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/stats/data/Stat.html#isModified--">isModified</a></span>()</code>
<div class="block">Returns true if the supplied statistic has been modified since it
was loaded from the repository.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/stats/data/Stat.html#persistTo-com.threerings.io.ObjectOutputStream-com.threerings.stats.data.Stat.AuxDataSource-">persistTo</a></span>(com.threerings.io.ObjectOutputStream&nbsp;out,
<a href="../../../../com/threerings/stats/data/Stat.AuxDataSource.html" title="interface in com.threerings.stats.data">Stat.AuxDataSource</a>&nbsp;aux)</code>
<div class="block">Serializes this instance for storage in the item database.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/stats/data/Stat.html#setModCount-byte-">setModCount</a></span>(byte&nbsp;modCount)</code>
<div class="block">Sets the modification count for this Stat.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/stats/data/Stat.html#setModified-boolean-">setModified</a></span>(boolean&nbsp;modified)</code>
<div class="block">Forces this stat to consider itself modified.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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="../../../../com/threerings/stats/data/Stat.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/stats/data/Stat.html#unpersistFrom-com.threerings.io.ObjectInputStream-com.threerings.stats.data.Stat.AuxDataSource-">unpersistFrom</a></span>(com.threerings.io.ObjectInputStream&nbsp;in,
<a href="../../../../com/threerings/stats/data/Stat.AuxDataSource.html" title="interface in com.threerings.stats.data">Stat.AuxDataSource</a>&nbsp;aux)</code>
<div class="block">Unserializes this item from data obtained from the item database.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>abstract <a href="http://docs.oracle.com/javase/1.5.0/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="../../../../com/threerings/stats/data/Stat.html#valueToString--">valueToString</a></span>()</code>
<div class="block">Derived statistics must override this method and render their value to a string.</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/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Stat--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Stat</h4>
<pre>public&nbsp;Stat()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getType-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre>public static&nbsp;<a href="../../../../com/threerings/stats/data/Stat.Type.html" title="interface in com.threerings.stats.data">Stat.Type</a>&nbsp;getType(int&nbsp;code)</pre>
<div class="block">Maps a <a href="../../../../com/threerings/stats/data/Stat.Type.html" title="interface in com.threerings.stats.data"><code>Stat.Type</code></a>'s code code back to a <a href="../../../../com/threerings/stats/data/Stat.Type.html" title="interface in com.threerings.stats.data"><code>Stat.Type</code></a> instance.</div>
</li>
</ul>
<a name="initType-com.threerings.stats.data.Stat.Type-com.threerings.stats.data.Stat-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initType</h4>
<pre>public static&nbsp;int&nbsp;initType(<a href="../../../../com/threerings/stats/data/Stat.Type.html" title="interface in com.threerings.stats.data">Stat.Type</a>&nbsp;type,
<a href="../../../../com/threerings/stats/data/Stat.html" title="class in com.threerings.stats.data">Stat</a>&nbsp;prototype)</pre>
<div class="block">Used by the <a href="../../../../com/threerings/stats/data/Stat.Type.html" title="interface in com.threerings.stats.data"><code>Stat.Type</code></a> implementation to map itself to an integer code.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the code to which the supplied type was mapped.</dd>
</dl>
</li>
</ul>
<a name="crc32-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>crc32</h4>
<pre>public static&nbsp;int&nbsp;crc32(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;string)</pre>
<div class="block">Computes and returns the CRC32 hash of the specified string.</div>
</li>
</ul>
<a name="getType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre>public&nbsp;<a href="../../../../com/threerings/stats/data/Stat.Type.html" title="interface in com.threerings.stats.data">Stat.Type</a>&nbsp;getType()</pre>
<div class="block">Returns the type of this statistic.</div>
</li>
</ul>
<a name="getCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCode</h4>
<pre>public&nbsp;int&nbsp;getCode()</pre>
<div class="block">Returns the integer code to which this statistic's name maps.</div>
</li>
</ul>
<a name="isModified--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isModified</h4>
<pre>public&nbsp;boolean&nbsp;isModified()</pre>
<div class="block">Returns true if the supplied statistic has been modified since it
was loaded from the repository.</div>
</li>
</ul>
<a name="setModified-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setModified</h4>
<pre>public&nbsp;void&nbsp;setModified(boolean&nbsp;modified)</pre>
<div class="block">Forces this stat to consider itself modified. Generally this is not
called but rather the derived class will update its modified state when
it is actually modified.</div>
</li>
</ul>
<a name="getModCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getModCount</h4>
<pre>public&nbsp;byte&nbsp;getModCount()</pre>
<div class="block">Returns the modification count of this Stat when it was loaded from the repository.</div>
</li>
</ul>
<a name="setModCount-byte-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setModCount</h4>
<pre>public&nbsp;void&nbsp;setModCount(byte&nbsp;modCount)</pre>
<div class="block">Sets the modification count for this Stat. StatRepository calls this when converting
a StatRecord into a Stat; it shouldn't be called otherwise.</div>
</li>
</ul>
<a name="persistTo-com.threerings.io.ObjectOutputStream-com.threerings.stats.data.Stat.AuxDataSource-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>persistTo</h4>
<pre>public abstract&nbsp;void&nbsp;persistTo(com.threerings.io.ObjectOutputStream&nbsp;out,
<a href="../../../../com/threerings/stats/data/Stat.AuxDataSource.html" title="interface in com.threerings.stats.data">Stat.AuxDataSource</a>&nbsp;aux)
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Serializes this instance for storage in the item database. Derived classes must override
this method to implement persistence.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="unpersistFrom-com.threerings.io.ObjectInputStream-com.threerings.stats.data.Stat.AuxDataSource-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unpersistFrom</h4>
<pre>public abstract&nbsp;void&nbsp;unpersistFrom(com.threerings.io.ObjectInputStream&nbsp;in,
<a href="../../../../com/threerings/stats/data/Stat.AuxDataSource.html" title="interface in com.threerings.stats.data">Stat.AuxDataSource</a>&nbsp;aux)
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/ClassNotFoundException.html?is-external=true" title="class or interface in java.lang">ClassNotFoundException</a></pre>
<div class="block">Unserializes this item from data obtained from the item database. Derived classes must
override this method to implement persistence.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/ClassNotFoundException.html?is-external=true" title="class or interface in java.lang">ClassNotFoundException</a></code></dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="valueToString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueToString</h4>
<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;valueToString()</pre>
<div class="block">Derived statistics must override this method and render their value to a string. Used by
<a href="../../../../com/threerings/stats/data/Stat.html#toString--"><code>toString()</code></a> and to display the value in game.</div>
</li>
</ul>
<a name="getKey--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKey</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getKey()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getKey</code>&nbsp;in interface&nbsp;<code>com.threerings.presents.dobj.DSet.Entry</code></dd>
</dl>
</li>
</ul>
<a name="clone--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>clone</h4>
<pre>public&nbsp;<a href="../../../../com/threerings/stats/data/Stat.html" title="class in com.threerings.stats.data">Stat</a>&nbsp;clone()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></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="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Stat.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-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/threerings/stats/data/ShortStringSetStat.html" title="class in com.threerings.stats.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/threerings/stats/data/Stat.AuxDataSource.html" title="interface in com.threerings.stats.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/threerings/stats/data/Stat.html" target="_top">Frames</a></li>
<li><a href="Stat.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&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>Field&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; 2015. All rights reserved.</small></p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink