http://git-wip-us.apache.org/repos/asf/polygene-website/blob/ba3a0fac/content/java/develop/javadocs/org/apache/polygene/api/association/NamedAssociationWrapper.html ---------------------------------------------------------------------- diff --git a/content/java/develop/javadocs/org/apache/polygene/api/association/NamedAssociationWrapper.html b/content/java/develop/javadocs/org/apache/polygene/api/association/NamedAssociationWrapper.html new file mode 100644 index 0000000..faf3e3a --- /dev/null +++ b/content/java/develop/javadocs/org/apache/polygene/api/association/NamedAssociationWrapper.html @@ -0,0 +1,603 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="fr"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>NamedAssociationWrapper (Apache Polygene⢠(Java Edition) SDK 3.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="NamedAssociationWrapper (Apache Polygene\u2122 (Java Edition) SDK 3.0-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":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="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</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/polygene/api/association/NamedAssociationMixin.html" title="class in org.apache.polygene.api.association"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/polygene/api/association/NamedAssociationWrapper.html" target="_top">Frames</a></li> +<li><a href="NamedAssociationWrapper.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: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </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.polygene.api.association</div> +<h2 title="Class NamedAssociationWrapper" class="title">Class NamedAssociationWrapper</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>org.apache.polygene.api.association.NamedAssociationWrapper</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</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>>, <a href="../../../../../org/apache/polygene/api/association/AbstractAssociation.html" title="interface in org.apache.polygene.api.association">AbstractAssociation</a>, <a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html" title="interface in org.apache.polygene.api.association">NamedAssociation</a><<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>></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">NamedAssociationWrapper</span> +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> +implements <a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html" title="interface in org.apache.polygene.api.association">NamedAssociation</a><<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">If you want to catch calls to NamedAssociations, then create a GenericConcern + that wraps the Polygene-supplied NamedAssociations instance with NamedAssociationsWrapper. Override + methods to perform your custom code.</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"> </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>protected <a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html" title="interface in org.apache.polygene.api.association">NamedAssociation</a><<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>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/association/NamedAssociationWrapper.html#next">next</a></span></code> </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"> </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="../../../../../org/apache/polygene/api/association/NamedAssociationWrapper.html#NamedAssociationWrapper-org.apache.polygene.api.association.NamedAssociation-">NamedAssociationWrapper</a></span>(<a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html" title="interface in org.apache.polygene.api.association">NamedAssociation</a><<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>> next)</code> </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/association/NamedAssociationWrapper.html#containsName-java.lang.String-">containsName</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> name)</code> +<div class="block">Checks if there is an association with the given name.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/association/NamedAssociationWrapper.html#count--">count</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/association/NamedAssociationWrapper.html#equals-java.lang.Object-">equals</a></span>(<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> obj)</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><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></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/association/NamedAssociationWrapper.html#get-java.lang.String-">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> name)</code> +<div class="block">Retrieves a named association.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/association/NamedAssociationWrapper.html#hashCode--">hashCode</a></span>()</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true"; title="class or interface in java.util">Iterator</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>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/association/NamedAssociationWrapper.html#iterator--">iterator</a></span>()</code> </td> +</tr> +<tr id="i6" 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="../../../../../org/apache/polygene/api/association/NamedAssociationWrapper.html#nameOf-java.lang.Object-">nameOf</a></span>(<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> entity)</code> +<div class="block">Checks if the entity is present.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html" title="interface in org.apache.polygene.api.association">NamedAssociation</a><<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>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/association/NamedAssociationWrapper.html#next--">next</a></span>()</code> </td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/association/NamedAssociationWrapper.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> name, + <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> entity)</code> +<div class="block">Adds a named assocation.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/polygene/api/entity/EntityReference.html" title="class in org.apache.polygene.api.entity">EntityReference</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/association/NamedAssociationWrapper.html#referenceOf-java.lang.String-">referenceOf</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> name)</code> +<div class="block">Returns the EntityReference for the Association with the given name.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true"; title="class or interface in java.util.stream">Stream</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.Entry.html?is-external=true"; title="class or interface in java.util">Map.Entry</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>,<a href="../../../../../org/apache/polygene/api/entity/EntityReference.html" title="class in org.apache.polygene.api.entity">EntityReference</a>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/association/NamedAssociationWrapper.html#references--">references</a></span>()</code> +<div class="block">Returns a stream of the references to the associated entities.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/association/NamedAssociationWrapper.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> name)</code> +<div class="block">Remove a named association.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</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>,<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>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/association/NamedAssociationWrapper.html#toMap--">toMap</a></span>()</code> </td> +</tr> +<tr id="i13" 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="../../../../../org/apache/polygene/api/association/NamedAssociationWrapper.html#toString--">toString</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class 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#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#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#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-ex ternal=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> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Iterable"> +<!-- --> +</a> +<h3>Methods inherited from interface java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#forEach-java.util.function.Consumer-"; title="class or interface in java.lang">forEach</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#spliterator--"; title="class or interface in java.lang">spliterator</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="next"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>next</h4> +<pre>protected <a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html" title="interface in org.apache.polygene.api.association">NamedAssociation</a><<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>> next</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="NamedAssociationWrapper-org.apache.polygene.api.association.NamedAssociation-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>NamedAssociationWrapper</h4> +<pre>public NamedAssociationWrapper(<a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html" title="interface in org.apache.polygene.api.association">NamedAssociation</a><<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>> next)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="next--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>next</h4> +<pre>public <a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html" title="interface in org.apache.polygene.api.association">NamedAssociation</a><<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>> next()</pre> +</li> +</ul> +<a name="iterator--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>iterator</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true"; title="class or interface in java.util">Iterator</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>> iterator()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#iterator--"; title="class or interface in java.lang">iterator</a></code> in interface <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</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>></code></dd> +</dl> +</li> +</ul> +<a name="count--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public int count()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html#count--">count</a></code> in interface <code><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html" title="interface in org.apache.polygene.api.association">NamedAssociation</a><<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>></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The number of named associations in this NamedAssociation.</dd> +</dl> +</li> +</ul> +<a name="containsName-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>containsName</h4> +<pre>public boolean containsName(<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> name)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html#containsName-java.lang.String-">NamedAssociation</a></code></span></div> +<div class="block">Checks if there is an association with the given name.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html#containsName-java.lang.String-">containsName</a></code> in interface <code><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html" title="interface in org.apache.polygene.api.association">NamedAssociation</a><<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>></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - The name of the association we are checking if it exists.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if it exists, false otherwise</dd> +</dl> +</li> +</ul> +<a name="put-java.lang.String-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>put</h4> +<pre>public boolean put(<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> name, + <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> entity)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html#put-java.lang.String-T-">NamedAssociation</a></code></span></div> +<div class="block">Adds a named assocation.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html#put-java.lang.String-T-">put</a></code> in interface <code><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html" title="interface in org.apache.polygene.api.association">NamedAssociation</a><<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>></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - The name of the association.</dd> +<dd><code>entity</code> - The entity for this named association.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if putted, false otherwise</dd> +</dl> +</li> +</ul> +<a name="remove-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>remove</h4> +<pre>public boolean remove(<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> name)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html#remove-java.lang.String-">NamedAssociation</a></code></span></div> +<div class="block">Remove a named association.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html#remove-java.lang.String-">remove</a></code> in interface <code><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html" title="interface in org.apache.polygene.api.association">NamedAssociation</a><<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>></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - The name of the association.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if removed, false otherwise</dd> +</dl> +</li> +</ul> +<a name="get-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <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> get(<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> name)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html#get-java.lang.String-">NamedAssociation</a></code></span></div> +<div class="block">Retrieves a named association.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html#get-java.lang.String-">get</a></code> in interface <code><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html" title="interface in org.apache.polygene.api.association">NamedAssociation</a><<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>></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - The name of the association.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The entity that has previously been associated.</dd> +</dl> +</li> +</ul> +<a name="nameOf-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nameOf</h4> +<pre>public <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> nameOf(<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> entity)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html#nameOf-T-">NamedAssociation</a></code></span></div> +<div class="block">Checks if the entity is present. + Note that this is potentially a very slow operation, depending on the size of the NamedAssociation.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html#nameOf-T-">nameOf</a></code> in interface <code><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html" title="interface in org.apache.polygene.api.association">NamedAssociation</a><<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>></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>entity</code> - The entity to look for.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The name of the entity if found, otherwise null.</dd> +</dl> +</li> +</ul> +<a name="toMap--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toMap</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</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>,<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>> toMap()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html#toMap--">toMap</a></code> in interface <code><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html" title="interface in org.apache.polygene.api.association">NamedAssociation</a><<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>></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A fully populated Map with the content of this NamedAssociation.</dd> +</dl> +</li> +</ul> +<a name="references--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>references</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true"; title="class or interface in java.util.stream">Stream</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.Entry.html?is-external=true"; title="class or interface in java.util">Map.Entry</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>,<a href="../../../../../org/apache/polygene/api/entity/EntityReference.html" title="class in org.apache.polygene.api.entity">EntityReference</a>>> references()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html#references--">NamedAssociation</a></code></span></div> +<div class="block">Returns a stream of the references to the associated entities.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html#references--">references</a></code> in interface <code><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html" title="interface in org.apache.polygene.api.association">NamedAssociation</a><<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>></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the references to the associated entities.</dd> +</dl> +</li> +</ul> +<a name="referenceOf-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>referenceOf</h4> +<pre>public <a href="../../../../../org/apache/polygene/api/entity/EntityReference.html" title="class in org.apache.polygene.api.entity">EntityReference</a> referenceOf(<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> name)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html#referenceOf-java.lang.String-">NamedAssociation</a></code></span></div> +<div class="block">Returns the EntityReference for the Association with the given name.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html#referenceOf-java.lang.String-">referenceOf</a></code> in interface <code><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html" title="interface in org.apache.polygene.api.association">NamedAssociation</a><<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>></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - The name of the association to return the EntityReference for</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The EntityReference of the association.</dd> +</dl> +</li> +</ul> +<a name="hashCode--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><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></code> in class <code><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></code></dd> +</dl> +</li> +</ul> +<a name="equals-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(<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> obj)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><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></code> in class <code><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></code></dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <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> toString()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><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></code> in class <code><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></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="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/polygene/api/association/NamedAssociationMixin.html" title="class in org.apache.polygene.api.association"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/polygene/api/association/NamedAssociationWrapper.html" target="_top">Frames</a></li> +<li><a href="NamedAssociationWrapper.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: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/polygene-website/blob/ba3a0fac/content/java/develop/javadocs/org/apache/polygene/api/association/package-frame.html ---------------------------------------------------------------------- diff --git a/content/java/develop/javadocs/org/apache/polygene/api/association/package-frame.html b/content/java/develop/javadocs/org/apache/polygene/api/association/package-frame.html new file mode 100644 index 0000000..f41a6a3 --- /dev/null +++ b/content/java/develop/javadocs/org/apache/polygene/api/association/package-frame.html @@ -0,0 +1,36 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="fr"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>org.apache.polygene.api.association (Apache Polygene⢠(Java Edition) SDK 3.0-SNAPSHOT)</title> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<h1 class="bar"><a href="../../../../../org/apache/polygene/api/association/package-summary.html" target="classFrame">org.apache.polygene.api.association</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="AbstractAssociation.html" title="interface in org.apache.polygene.api.association" target="classFrame"><span class="interfaceName">AbstractAssociation</span></a></li> +<li><a href="Association.html" title="interface in org.apache.polygene.api.association" target="classFrame"><span class="interfaceName">Association</span></a></li> +<li><a href="AssociationDescriptor.html" title="interface in org.apache.polygene.api.association" target="classFrame"><span class="interfaceName">AssociationDescriptor</span></a></li> +<li><a href="AssociationStateDescriptor.html" title="interface in org.apache.polygene.api.association" target="classFrame"><span class="interfaceName">AssociationStateDescriptor</span></a></li> +<li><a href="AssociationStateHolder.html" title="interface in org.apache.polygene.api.association" target="classFrame"><span class="interfaceName">AssociationStateHolder</span></a></li> +<li><a href="ManyAssociation.html" title="interface in org.apache.polygene.api.association" target="classFrame"><span class="interfaceName">ManyAssociation</span></a></li> +<li><a href="NamedAssociation.html" title="interface in org.apache.polygene.api.association" target="classFrame"><span class="interfaceName">NamedAssociation</span></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="AssociationMixin.html" title="class in org.apache.polygene.api.association" target="classFrame">AssociationMixin</a></li> +<li><a href="AssociationWrapper.html" title="class in org.apache.polygene.api.association" target="classFrame">AssociationWrapper</a></li> +<li><a href="GenericAssociationInfo.html" title="class in org.apache.polygene.api.association" target="classFrame">GenericAssociationInfo</a></li> +<li><a href="ManyAssociationMixin.html" title="class in org.apache.polygene.api.association" target="classFrame">ManyAssociationMixin</a></li> +<li><a href="ManyAssociationWrapper.html" title="class in org.apache.polygene.api.association" target="classFrame">ManyAssociationWrapper</a></li> +<li><a href="NamedAssociationMixin.html" title="class in org.apache.polygene.api.association" target="classFrame">NamedAssociationMixin</a></li> +<li><a href="NamedAssociationWrapper.html" title="class in org.apache.polygene.api.association" target="classFrame">NamedAssociationWrapper</a></li> +</ul> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/polygene-website/blob/ba3a0fac/content/java/develop/javadocs/org/apache/polygene/api/association/package-summary.html ---------------------------------------------------------------------- diff --git a/content/java/develop/javadocs/org/apache/polygene/api/association/package-summary.html b/content/java/develop/javadocs/org/apache/polygene/api/association/package-summary.html new file mode 100644 index 0000000..1403da2 --- /dev/null +++ b/content/java/develop/javadocs/org/apache/polygene/api/association/package-summary.html @@ -0,0 +1,243 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="fr"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>org.apache.polygene.api.association (Apache Polygene⢠(Java Edition) SDK 3.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="org.apache.polygene.api.association (Apache Polygene\u2122 (Java Edition) SDK 3.0-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +</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 class="navBarCell1Rev">Package</li> +<li>Class</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/polygene/api/activation/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../org/apache/polygene/api/cache/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/polygene/api/association/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Package" class="title">Package org.apache.polygene.api.association</h1> +<div class="docSummary"> +<div class="block">Association API.</div> +</div> +<p>See: <a href="#package.description">Description</a></p> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> +<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Interface</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/polygene/api/association/AbstractAssociation.html" title="interface in org.apache.polygene.api.association">AbstractAssociation</a></td> +<td class="colLast"> +<div class="block">Base interface for all associations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/polygene/api/association/Association.html" title="interface in org.apache.polygene.api.association">Association</a><T></td> +<td class="colLast"> +<div class="block">Association to a single EntityComposite.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/polygene/api/association/AssociationDescriptor.html" title="interface in org.apache.polygene.api.association">AssociationDescriptor</a></td> +<td class="colLast"> +<div class="block">Association Descriptor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/polygene/api/association/AssociationStateDescriptor.html" title="interface in org.apache.polygene.api.association">AssociationStateDescriptor</a></td> +<td class="colLast"> +<div class="block">Associations State Descriptor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/polygene/api/association/AssociationStateHolder.html" title="interface in org.apache.polygene.api.association">AssociationStateHolder</a></td> +<td class="colLast"> +<div class="block">This represents the state of a entity (properties+associations).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/polygene/api/association/ManyAssociation.html" title="interface in org.apache.polygene.api.association">ManyAssociation</a><T></td> +<td class="colLast"> +<div class="block">Association to a collection of entities.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html" title="interface in org.apache.polygene.api.association">NamedAssociation</a><T></td> +<td class="colLast"> +<div class="block">Association to named Entities.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/polygene/api/association/AssociationMixin.html" title="class in org.apache.polygene.api.association">AssociationMixin</a></td> +<td class="colLast"> +<div class="block">Generic mixin for associations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/polygene/api/association/AssociationWrapper.html" title="class in org.apache.polygene.api.association">AssociationWrapper</a></td> +<td class="colLast"> +<div class="block">If you want to catch getting and setting association, then create a GenericConcern + that wraps the Polygene-supplied Association instance with AssociationWrappers.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/polygene/api/association/GenericAssociationInfo.html" title="class in org.apache.polygene.api.association">GenericAssociationInfo</a></td> +<td class="colLast"> +<div class="block">Generic Association info.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/polygene/api/association/ManyAssociationMixin.html" title="class in org.apache.polygene.api.association">ManyAssociationMixin</a></td> +<td class="colLast"> +<div class="block">Generic mixin for associations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/polygene/api/association/ManyAssociationWrapper.html" title="class in org.apache.polygene.api.association">ManyAssociationWrapper</a></td> +<td class="colLast"> +<div class="block">If you want to catch calls to ManyAssociations, then create a GenericConcern + that wraps the Polygene-supplied ManyAssociation instance with ManyAssociationWrappers.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/polygene/api/association/NamedAssociationMixin.html" title="class in org.apache.polygene.api.association">NamedAssociationMixin</a></td> +<td class="colLast"> +<div class="block">Generic mixin for NamedAssociations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/polygene/api/association/NamedAssociationWrapper.html" title="class in org.apache.polygene.api.association">NamedAssociationWrapper</a></td> +<td class="colLast"> +<div class="block">If you want to catch calls to NamedAssociations, then create a GenericConcern + that wraps the Polygene-supplied NamedAssociations instance with NamedAssociationsWrapper.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package.description"> +<!-- --> +</a> +<h2 title="Package org.apache.polygene.api.association Description">Package org.apache.polygene.api.association Description</h2> +<div class="block"><h2>Association API.</h2></div> +</div> +<!-- ======= 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 class="navBarCell1Rev">Package</li> +<li>Class</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/polygene/api/activation/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../org/apache/polygene/api/cache/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/polygene/api/association/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/polygene-website/blob/ba3a0fac/content/java/develop/javadocs/org/apache/polygene/api/association/package-tree.html ---------------------------------------------------------------------- diff --git a/content/java/develop/javadocs/org/apache/polygene/api/association/package-tree.html b/content/java/develop/javadocs/org/apache/polygene/api/association/package-tree.html new file mode 100644 index 0000000..d372bec --- /dev/null +++ b/content/java/develop/javadocs/org/apache/polygene/api/association/package-tree.html @@ -0,0 +1,172 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="fr"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>org.apache.polygene.api.association Class Hierarchy (Apache Polygene⢠(Java Edition) SDK 3.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="org.apache.polygene.api.association Class Hierarchy (Apache Polygene\u2122 (Java Edition) SDK 3.0-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +</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</li> +<li class="navBarCell1Rev">Tree</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/polygene/api/activation/package-tree.html">Prev</a></li> +<li><a href="../../../../../org/apache/polygene/api/cache/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/polygene/api/association/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.polygene.api.association</h1> +<span class="packageHierarchyLabel">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">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"><span class="typeNameLink">Object</span></a> +<ul> +<li type="circle">org.apache.polygene.api.association.<a href="../../../../../org/apache/polygene/api/association/AssociationMixin.html" title="class in org.apache.polygene.api.association"><span class="typeNameLink">AssociationMixin</span></a> (implements java.lang.reflect.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/reflect/InvocationHandler.html?is-external=true"; title="class or interface in java.lang.reflect">InvocationHandler</a>)</li> +<li type="circle">org.apache.polygene.api.association.<a href="../../../../../org/apache/polygene/api/association/AssociationWrapper.html" title="class in org.apache.polygene.api.association"><span class="typeNameLink">AssociationWrapper</span></a> (implements org.apache.polygene.api.association.<a href="../../../../../org/apache/polygene/api/association/Association.html" title="interface in org.apache.polygene.api.association">Association</a><T>)</li> +<li type="circle">org.apache.polygene.api.association.<a href="../../../../../org/apache/polygene/api/association/GenericAssociationInfo.html" title="class in org.apache.polygene.api.association"><span class="typeNameLink">GenericAssociationInfo</span></a></li> +<li type="circle">org.apache.polygene.api.association.<a href="../../../../../org/apache/polygene/api/association/ManyAssociationMixin.html" title="class in org.apache.polygene.api.association"><span class="typeNameLink">ManyAssociationMixin</span></a> (implements java.lang.reflect.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/reflect/InvocationHandler.html?is-external=true"; title="class or interface in java.lang.reflect">InvocationHandler</a>)</li> +<li type="circle">org.apache.polygene.api.association.<a href="../../../../../org/apache/polygene/api/association/ManyAssociationWrapper.html" title="class in org.apache.polygene.api.association"><span class="typeNameLink">ManyAssociationWrapper</span></a> (implements org.apache.polygene.api.association.<a href="../../../../../org/apache/polygene/api/association/ManyAssociation.html" title="interface in org.apache.polygene.api.association">ManyAssociation</a><T>)</li> +<li type="circle">org.apache.polygene.api.association.<a href="../../../../../org/apache/polygene/api/association/NamedAssociationMixin.html" title="class in org.apache.polygene.api.association"><span class="typeNameLink">NamedAssociationMixin</span></a> (implements java.lang.reflect.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/reflect/InvocationHandler.html?is-external=true"; title="class or interface in java.lang.reflect">InvocationHandler</a>)</li> +<li type="circle">org.apache.polygene.api.association.<a href="../../../../../org/apache/polygene/api/association/NamedAssociationWrapper.html" title="class in org.apache.polygene.api.association"><span class="typeNameLink">NamedAssociationWrapper</span></a> (implements org.apache.polygene.api.association.<a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html" title="interface in org.apache.polygene.api.association">NamedAssociation</a><T>)</li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">org.apache.polygene.api.association.<a href="../../../../../org/apache/polygene/api/association/AbstractAssociation.html" title="interface in org.apache.polygene.api.association"><span class="typeNameLink">AbstractAssociation</span></a> +<ul> +<li type="circle">org.apache.polygene.api.association.<a href="../../../../../org/apache/polygene/api/association/Association.html" title="interface in org.apache.polygene.api.association"><span class="typeNameLink">Association</span></a><T></li> +<li type="circle">org.apache.polygene.api.association.<a href="../../../../../org/apache/polygene/api/association/ManyAssociation.html" title="interface in org.apache.polygene.api.association"><span class="typeNameLink">ManyAssociation</span></a><T> (also extends java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><T>)</li> +<li type="circle">org.apache.polygene.api.association.<a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html" title="interface in org.apache.polygene.api.association"><span class="typeNameLink">NamedAssociation</span></a><T> (also extends java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><T>)</li> +</ul> +</li> +<li type="circle">java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang"><span class="typeNameLink">Iterable</span></a><T> +<ul> +<li type="circle">org.apache.polygene.api.association.<a href="../../../../../org/apache/polygene/api/association/ManyAssociation.html" title="interface in org.apache.polygene.api.association"><span class="typeNameLink">ManyAssociation</span></a><T> (also extends org.apache.polygene.api.association.<a href="../../../../../org/apache/polygene/api/association/AbstractAssociation.html" title="interface in org.apache.polygene.api.association">AbstractAssociation</a>)</li> +<li type="circle">org.apache.polygene.api.association.<a href="../../../../../org/apache/polygene/api/association/NamedAssociation.html" title="interface in org.apache.polygene.api.association"><span class="typeNameLink">NamedAssociation</span></a><T> (also extends org.apache.polygene.api.association.<a href="../../../../../org/apache/polygene/api/association/AbstractAssociation.html" title="interface in org.apache.polygene.api.association">AbstractAssociation</a>)</li> +</ul> +</li> +<li type="circle">org.apache.polygene.api.structure.<a href="../../../../../org/apache/polygene/api/structure/MetaInfoHolder.html" title="interface in org.apache.polygene.api.structure"><span class="typeNameLink">MetaInfoHolder</span></a> +<ul> +<li type="circle">org.apache.polygene.api.association.<a href="../../../../../org/apache/polygene/api/association/AssociationDescriptor.html" title="interface in org.apache.polygene.api.association"><span class="typeNameLink">AssociationDescriptor</span></a></li> +</ul> +</li> +<li type="circle">org.apache.polygene.api.composite.<a href="../../../../../org/apache/polygene/api/composite/StateDescriptor.html" title="interface in org.apache.polygene.api.composite"><span class="typeNameLink">StateDescriptor</span></a> +<ul> +<li type="circle">org.apache.polygene.api.association.<a href="../../../../../org/apache/polygene/api/association/AssociationStateDescriptor.html" title="interface in org.apache.polygene.api.association"><span class="typeNameLink">AssociationStateDescriptor</span></a></li> +</ul> +</li> +<li type="circle">org.apache.polygene.api.property.<a href="../../../../../org/apache/polygene/api/property/StateHolder.html" title="interface in org.apache.polygene.api.property"><span class="typeNameLink">StateHolder</span></a> +<ul> +<li type="circle">org.apache.polygene.api.association.<a href="../../../../../org/apache/polygene/api/association/AssociationStateHolder.html" title="interface in org.apache.polygene.api.association"><span class="typeNameLink">AssociationStateHolder</span></a></li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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</li> +<li class="navBarCell1Rev">Tree</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/polygene/api/activation/package-tree.html">Prev</a></li> +<li><a href="../../../../../org/apache/polygene/api/cache/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/polygene/api/association/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/polygene-website/blob/ba3a0fac/content/java/develop/javadocs/org/apache/polygene/api/cache/CacheOptions.html ---------------------------------------------------------------------- diff --git a/content/java/develop/javadocs/org/apache/polygene/api/cache/CacheOptions.html b/content/java/develop/javadocs/org/apache/polygene/api/cache/CacheOptions.html new file mode 100644 index 0000000..2d5e94d --- /dev/null +++ b/content/java/develop/javadocs/org/apache/polygene/api/cache/CacheOptions.html @@ -0,0 +1,387 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="fr"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>CacheOptions (Apache Polygene⢠(Java Edition) SDK 3.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="CacheOptions (Apache Polygene\u2122 (Java Edition) SDK 3.0-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":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="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</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>Prev Class</li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/polygene/api/cache/CacheOptions.html" target="_top">Frames</a></li> +<li><a href="CacheOptions.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: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </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.polygene.api.cache</div> +<h2 title="Class CacheOptions" class="title">Class CacheOptions</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>org.apache.polygene.api.cache.CacheOptions</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">CacheOptions</span> +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">CacheOptions is a metaInfo class for the Cache system for Entity persistence. + CacheOptions should be assigned to the Usecase of the UnitOfWork, to give hint on caching to entity stores. + See <a href="../../../../../org/apache/polygene/api/usecase/UsecaseBuilder.html" title="class in org.apache.polygene.api.usecase"><code>UsecaseBuilder</code></a> on how to set the metaInfo on Usecases.</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"> </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>static <a href="../../../../../org/apache/polygene/api/cache/CacheOptions.html" title="class in org.apache.polygene.api.cache">CacheOptions</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/cache/CacheOptions.html#ALWAYS">ALWAYS</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/polygene/api/cache/CacheOptions.html" title="class in org.apache.polygene.api.cache">CacheOptions</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/cache/CacheOptions.html#NEVER">NEVER</a></span></code> </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"> </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="../../../../../org/apache/polygene/api/cache/CacheOptions.html#CacheOptions-boolean-boolean-boolean-">CacheOptions</a></span>(boolean cacheOnRead, + boolean cacheOnWrite, + boolean cacheOnNew)</code> +<div class="block">Constructor for CacheOptions.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/cache/CacheOptions.html#cacheOnNew--">cacheOnNew</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/cache/CacheOptions.html#cacheOnRead--">cacheOnRead</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/cache/CacheOptions.html#cacheOnWrite--">cacheOnWrite</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class 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="ALWAYS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ALWAYS</h4> +<pre>public static final <a href="../../../../../org/apache/polygene/api/cache/CacheOptions.html" title="class in org.apache.polygene.api.cache">CacheOptions</a> ALWAYS</pre> +</li> +</ul> +<a name="NEVER"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>NEVER</h4> +<pre>public static final <a href="../../../../../org/apache/polygene/api/cache/CacheOptions.html" title="class in org.apache.polygene.api.cache">CacheOptions</a> NEVER</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="CacheOptions-boolean-boolean-boolean-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CacheOptions</h4> +<pre>public CacheOptions(boolean cacheOnRead, + boolean cacheOnWrite, + boolean cacheOnNew)</pre> +<div class="block">Constructor for CacheOptions.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>cacheOnRead</code> - if true, give the hint to the Cache system that it may not be a good idea to cache the + read values. This is useful when it is known that the read will be over a large set and + shouldn't affect the existing cached entities. For instance, when traversing the EntityStore + this option is set to false.</dd> +<dd><code>cacheOnWrite</code> - if true, give the hint to the Cache system that it may not be a good idea to cache the + entity when the value is updated. If this is false, the cache should be emptied from any + cached entity instead of updated. There are few cases when this is useful, and if this is + false, it makes sense that the <i>cacheOnRead</i> is also false.</dd> +<dd><code>cacheOnNew</code> - if true, give the hint to the Cache system that it may not be a good idea to cache a newly + created Entity, as it is not likely to be read in the near future. This is useful when + batch inserts are being made.</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="cacheOnRead--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cacheOnRead</h4> +<pre>public boolean cacheOnRead()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>if true, give the hint to the Cache system that it may not be a good idea to cache the + read values. This is useful when it is known that the read will be over a large set and + shouldn't affect the existing cached entities. For instance, when traversing the EntityStore</dd> +</dl> +</li> +</ul> +<a name="cacheOnWrite--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cacheOnWrite</h4> +<pre>public boolean cacheOnWrite()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>if true, give the hint to the Cache system that it may not be a good idea to cache the + entity when the value is updated. If this is false, the cache should be emptied from any + cached entity instead of updated. There are few cases when this is useful, and if this is + false, it makes sense that the <i>cacheOnRead</i> is also false.</dd> +</dl> +</li> +</ul> +<a name="cacheOnNew--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>cacheOnNew</h4> +<pre>public boolean cacheOnNew()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>if true, give the hint to the Cache system that it may not be a good idea to cache a newly + created Entity, as it is not likely to be read in the near future. This is useful when + batch inserts are being made.</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="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>Prev Class</li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/polygene/api/cache/CacheOptions.html" target="_top">Frames</a></li> +<li><a href="CacheOptions.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: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/polygene-website/blob/ba3a0fac/content/java/develop/javadocs/org/apache/polygene/api/cache/package-frame.html ---------------------------------------------------------------------- diff --git a/content/java/develop/javadocs/org/apache/polygene/api/cache/package-frame.html b/content/java/develop/javadocs/org/apache/polygene/api/cache/package-frame.html new file mode 100644 index 0000000..3ce5224 --- /dev/null +++ b/content/java/develop/javadocs/org/apache/polygene/api/cache/package-frame.html @@ -0,0 +1,20 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="fr"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>org.apache.polygene.api.cache (Apache Polygene⢠(Java Edition) SDK 3.0-SNAPSHOT)</title> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<h1 class="bar"><a href="../../../../../org/apache/polygene/api/cache/package-summary.html" target="classFrame">org.apache.polygene.api.cache</a></h1> +<div class="indexContainer"> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="CacheOptions.html" title="class in org.apache.polygene.api.cache" target="classFrame">CacheOptions</a></li> +</ul> +</div> +</body> +</html>
