blob: 5652cadbe3d757274b2ae78f318cd34539254a7b [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.10) on Mon Dec 05 10:27:04 MSK 2022 -->
<title>org.apache.cayenne.util (cayenne-doc: Cayenne Documentation 4.2.RC2 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-12-05">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.cayenne.util (cayenne-doc: Cayenne Documentation 4.2.RC2 API)";
}
}
catch(err) {
}
//-->
var pathtoroot = "../../../../";
var useModuleDirectories = false;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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 class="aboutLanguage"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.cayenne.util</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<div class="block">General utility classes.</div>
</section>
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CayenneMapEntry.html" title="interface in org.apache.cayenne.util">CayenneMapEntry</a></th>
<td class="colLast">
<div class="block">Defining a double-linked named entry in CayenneMap.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="EntityMergeListener.html" title="interface in org.apache.cayenne.util">EntityMergeListener</a></th>
<td class="colLast">
<div class="block">EntityMergeListener interface defines API useful for listening to
EntityMergeSupport processing.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="PersistentObjectCollection.html" title="interface in org.apache.cayenne.util">PersistentObjectCollection</a>&lt;E&gt;</th>
<td class="colLast">
<div class="block">Simple interface to unify PersistentObject* collections in way of
setting properties directly</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</a></th>
<td class="colLast">
<div class="block">Interface for Cayenne objects that can be saved to XML.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ArrayUtil.html" title="class in org.apache.cayenne.util">ArrayUtil</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CompareToBuilder.html" title="class in org.apache.cayenne.util">CompareToBuilder</a></th>
<td class="colLast">
<div class="block">Assists in implementing <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true#compareTo(T)" title="class or interface in java.lang" class="externalLink"><code>Comparable.compareTo(Object)</code></a> methods.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ConversionUtil.html" title="class in org.apache.cayenne.util">ConversionUtil</a></th>
<td class="colLast">
<div class="block">A collection of static conversion utility methods.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DeepMergeOperation.html" title="class in org.apache.cayenne.util">DeepMergeOperation</a></th>
<td class="colLast">
<div class="block">An operation that merges changes from an object graph, whose objects are registered in
some ObjectContext, to peer objects in an ObjectConext that is a child of that context.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DeleteRuleUpdater.html" title="class in org.apache.cayenne.util">DeleteRuleUpdater</a></th>
<td class="colLast">
<div class="block">DeleteRuleUpdater is responsible for auto-setting delete rules for object relationships</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="EqualsBuilder.html" title="class in org.apache.cayenne.util">EqualsBuilder</a></th>
<td class="colLast">
<div class="block">Assists in implementing <a href="https://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" class="externalLink"><code>Object.equals(Object)</code></a> methods.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="EventUtil.html" title="class in org.apache.cayenne.util">EventUtil</a></th>
<td class="colLast">
<div class="block">Contains access stack events related utility methods.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="GenericQueryResult.html" title="class in org.apache.cayenne.util">GenericQueryResult</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">Generic implementation of QueryResult using List as QueryResultItem storage.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="GenericResponse.html" title="class in org.apache.cayenne.util">GenericResponse</a></th>
<td class="colLast">
<div class="block">A simple serializable implementation of QueryResponse.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="HashCodeBuilder.html" title="class in org.apache.cayenne.util">HashCodeBuilder</a></th>
<td class="colLast">
<div class="block">Assists in implementing <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink"><code>Object.hashCode()</code></a> methods.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IDUtil.html" title="class in org.apache.cayenne.util">IDUtil</a></th>
<td class="colLast">
<div class="block">helper class to generate pseudo-GUID sequences.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IncrementalListResponse.html" title="class in org.apache.cayenne.util">IncrementalListResponse</a></th>
<td class="colLast">
<div class="block">A QueryResponse that contains a sublist of the query result.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IndexPropertyList.html" title="class in org.apache.cayenne.util">IndexPropertyList</a></th>
<td class="colLast">
<div class="block">A List implementation that would maintain its internal ordering based on some object
numeric "index" property.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Invocation.html" title="class in org.apache.cayenne.util">Invocation</a></th>
<td class="colLast">
<div class="block">Invocation represents a dynamic method invocation bound to a specific target.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ListResponse.html" title="class in org.apache.cayenne.util">ListResponse</a></th>
<td class="colLast">
<div class="block">A QueryResponse optimized to hold a single object or data row list.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="LocalizedStringsHandler.html" title="class in org.apache.cayenne.util">LocalizedStringsHandler</a></th>
<td class="colLast">
<div class="block">Provides access to various modeler resources (mainly strings) obtained via a
ResourceBundle.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MemoryBlob.html" title="class in org.apache.cayenne.util">MemoryBlob</a></th>
<td class="colLast">
<div class="block">A Blob implementation that stores content in memory.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MemoryClob.html" title="class in org.apache.cayenne.util">MemoryClob</a></th>
<td class="colLast">
<div class="block">A Clob implementation that stores contents in memory.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ObjectContextGraphAction.html" title="class in org.apache.cayenne.util">ObjectContextGraphAction</a></th>
<td class="colLast">
<div class="block">A base implementation of a helper class to handle
<a href="../ObjectContext.html#propertyChanged(org.apache.cayenne.Persistent,java.lang.String,java.lang.Object,java.lang.Object)"><code>ObjectContext.propertyChanged(org.apache.cayenne.Persistent, String, Object, Object)</code></a>
processing on behalf of an ObjectContext.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ObjectContextQueryAction.html" title="class in org.apache.cayenne.util">ObjectContextQueryAction</a></th>
<td class="colLast">
<div class="block">A helper class that implements
<a href="../DataChannel.html#onQuery(org.apache.cayenne.ObjectContext,org.apache.cayenne.query.Query)"><code>DataChannel.onQuery(ObjectContext, Query)</code></a> logic on behalf of
an ObjectContext.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ObjectDetachOperation.html" title="class in org.apache.cayenne.util">ObjectDetachOperation</a></th>
<td class="colLast">
<div class="block">An operation that creates a subgraph of detached objects, using the PrefetchTree to
delineate the graph boundaries.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="PersistentObjectHolder.html" title="class in org.apache.cayenne.util">PersistentObjectHolder</a>&lt;E&gt;</th>
<td class="colLast">
<div class="block">A ValueHolder implementation that holds a single Persistent object related to an object
used to initialize PersistentObjectHolder.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="PersistentObjectList.html" title="class in org.apache.cayenne.util">PersistentObjectList</a>&lt;E&gt;</th>
<td class="colLast">
<div class="block">A list of persistent objects lazily resolved on the first access.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="PersistentObjectMap.html" title="class in org.apache.cayenne.util">PersistentObjectMap</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="PersistentObjectSet.html" title="class in org.apache.cayenne.util">PersistentObjectSet</a>&lt;E&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ProcedureResultBuilder.html" title="class in org.apache.cayenne.util">ProcedureResultBuilder</a>&lt;T&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="QueryResultBuilder.html" title="class in org.apache.cayenne.util">QueryResultBuilder</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RelationshipFault.html" title="class in org.apache.cayenne.util">RelationshipFault</a>&lt;E&gt;</th>
<td class="colLast">
<div class="block">An abstract superclass of lazily faulted to-one and to-many relationships.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ResultIteratorIterator.html" title="class in org.apache.cayenne.util">ResultIteratorIterator</a>&lt;T&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ShallowMergeOperation.html" title="class in org.apache.cayenne.util">ShallowMergeOperation</a></th>
<td class="colLast">
<div class="block">An operation that merges changes from a single object registered in some ObjectContext,
to a peer object in an ObjectConext that is a child of that context.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SingleEntryMap.html" title="class in org.apache.cayenne.util">SingleEntryMap</a>&lt;K,&#8203;V&gt;</th>
<td class="colLast">
<div class="block">Optimized mutable single-entry map.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SoftValueMap.html" title="class in org.apache.cayenne.util">SoftValueMap</a>&lt;K,&#8203;V&gt;</th>
<td class="colLast">
<div class="block">Map that stores values wrapped into <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ref/SoftReference.html?is-external=true" title="class or interface in java.lang.ref" class="externalLink"><code>SoftReference</code></a></div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ToStringBuilder.html" title="class in org.apache.cayenne.util">ToStringBuilder</a></th>
<td class="colLast">
<div class="block">A utility class to simplify implementation of Object toString methods.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Util.html" title="class in org.apache.cayenne.util">Util</a></th>
<td class="colLast">
<div class="block">Contains various unorganized static utility methods used across Cayenne.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="WeakValueMap.html" title="class in org.apache.cayenne.util">WeakValueMap</a>&lt;K,&#8203;V&gt;</th>
<td class="colLast">
<div class="block">Map that stores values wrapped into <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ref/WeakReference.html?is-external=true" title="class or interface in java.lang.ref" class="externalLink"><code>WeakReference</code></a></div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</a></th>
<td class="colLast">
<div class="block">
A helper class to encode objects to XML.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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 class="aboutLanguage"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2001&#x2013;2022 <a href="https://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</footer>
</body>
</html>