blob: 6f58151b9a0aa9425c5161ed894bdc28c46cce32 [file] [log] [blame]
<!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 (version 1.7.0_55) on Thu May 15 17:23:35 PDT 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Dirtyable (Apache Gora 0.4 API)</title>
<meta name="date" content="2014-05-15">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Dirtyable (Apache Gora 0.4 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/Dirtyable.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="../../../../org/apache/gora/persistency/BeanFactory.html" title="interface in org.apache.gora.persistency"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/gora/persistency/Persistent.html" title="interface in org.apache.gora.persistency"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/gora/persistency/Dirtyable.html" target="_top">Frames</a></li>
<li><a href="Dirtyable.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All 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>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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">org.apache.gora.persistency</div>
<h2 title="Interface Dirtyable" class="title">Interface Dirtyable</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../org/apache/gora/persistency/Persistent.html" title="interface in org.apache.gora.persistency">Persistent</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/gora/persistency/impl/DirtyCollectionWrapper.html" title="class in org.apache.gora.persistency.impl">DirtyCollectionWrapper</a>, <a href="../../../../org/apache/gora/persistency/impl/DirtyListWrapper.html" title="class in org.apache.gora.persistency.impl">DirtyListWrapper</a>, <a href="../../../../org/apache/gora/persistency/impl/DirtyMapWrapper.html" title="class in org.apache.gora.persistency.impl">DirtyMapWrapper</a>, <a href="../../../../org/apache/gora/persistency/impl/DirtyMapWrapper.DirtyEntryWrapper.html" title="class in org.apache.gora.persistency.impl">DirtyMapWrapper.DirtyEntryWrapper</a>, <a href="../../../../org/apache/gora/persistency/impl/DirtySetWrapper.html" title="class in org.apache.gora.persistency.impl">DirtySetWrapper</a>, <a href="../../../../org/apache/gora/tutorial/log/generated/MetricDatum.html" title="class in org.apache.gora.tutorial.log.generated">MetricDatum</a>, <a href="../../../../org/apache/gora/tutorial/log/generated/MetricDatum.Tombstone.html" title="class in org.apache.gora.tutorial.log.generated">MetricDatum.Tombstone</a>, <a href="../../../../org/apache/gora/tutorial/log/generated/Pageview.html" title="class in org.apache.gora.tutorial.log.generated">Pageview</a>, <a href="../../../../org/apache/gora/tutorial/log/generated/Pageview.Tombstone.html" title="class in org.apache.gora.tutorial.log.generated">Pageview.Tombstone</a>, <a href="../../../../org/apache/gora/persistency/impl/PersistentBase.html" title="class in org.apache.gora.persistency.impl">PersistentBase</a>, <a href="../../../../org/apache/gora/persistency/ws/impl/PersistentWSBase.html" title="class in org.apache.gora.persistency.ws.impl">PersistentWSBase</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Dirtyable</span></pre>
<div class="block">Interface designed to accomodate structures that can be dirty, such as maps
and lists, but whose dirtyness should not be set directly because dirtyness
results from structural modification or content change, and which have no
notion of ordered fields (such as Persistent).</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/gora/persistency/Dirtyable.html#clearDirty()">clearDirty</a></strong>()</code>
<div class="block">Clears the dirty state.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/gora/persistency/Dirtyable.html#isDirty()">isDirty</a></strong>()</code>
<div class="block">Returns whether any of the fields of the object has been modified after
construction or loading.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isDirty()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDirty</h4>
<pre>boolean&nbsp;isDirty()</pre>
<div class="block">Returns whether any of the fields of the object has been modified after
construction or loading.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>whether any of the fields of the object has changed</dd></dl>
</li>
</ul>
<a name="clearDirty()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>clearDirty</h4>
<pre>void&nbsp;clearDirty()</pre>
<div class="block">Clears the dirty state.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/Dirtyable.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="../../../../org/apache/gora/persistency/BeanFactory.html" title="interface in org.apache.gora.persistency"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/gora/persistency/Persistent.html" title="interface in org.apache.gora.persistency"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/gora/persistency/Dirtyable.html" target="_top">Frames</a></li>
<li><a href="Dirtyable.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All 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>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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; 2010-2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>