| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ReconnectLocationPool (Qpid ProtonJ2 Parent 1.0.0-M19 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.qpid.protonj2.client.util, class: ReconnectLocationPool"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/ReconnectLocationPool.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.qpid.protonj2.client.util</a></div> |
| <h1 title="Class ReconnectLocationPool" class="title">Class ReconnectLocationPool</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.qpid.protonj2.client.util.ReconnectLocationPool</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ReconnectLocationPool</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> |
| <div class="block">Manages the list of available reconnect entries that are used to connect |
| and recover a connection.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ReconnectLocationPool</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates an empty <a href="ReconnectLocationPool.html" title="class in org.apache.qpid.protonj2.client.util"><code>ReconnectLocationPool</code></a>.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.util.List)" class="member-name-link">ReconnectLocationPool</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client">ReconnectLocation</a>> backups)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Creates a new <a href="ReconnectLocationPool.html" title="class in org.apache.qpid.protonj2.client.util"><code>ReconnectLocationPool</code></a> with the provided <a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectLocation</code></a> values.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(org.apache.qpid.protonj2.client.ReconnectLocation)" class="member-name-link">add</a><wbr>(<a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client">ReconnectLocation</a> entry)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds a new entry to the pool if not already contained within.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addAll(java.util.List)" class="member-name-link">addAll</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client">ReconnectLocation</a>> additions)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds a list of new <a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectLocation</code></a> values to the pool if not already contained within.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addFirst(org.apache.qpid.protonj2.client.ReconnectLocation)" class="member-name-link">addFirst</a><wbr>(<a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client">ReconnectLocation</a> entry)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds a new <a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectLocation</code></a> to the pool if not already contained within.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client">ReconnectLocation</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getList()" class="member-name-link">getList</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the current list of <a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectLocation</code></a> values.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client">ReconnectLocation</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNext()" class="member-name-link">getNext</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the next entry in the pool of entries.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#remove(org.apache.qpid.protonj2.client.ReconnectLocation)" class="member-name-link">remove</a><wbr>(<a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client">ReconnectLocation</a> entry)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Remove a <a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectLocation</code></a> from the pool if present, otherwise has no effect.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#removeAll()" class="member-name-link">removeAll</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Removes all currently configured <a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectLocation</code></a> from the pool, no new <a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectLocation</code></a> values |
| will be served from this pool until new ones are added.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#replaceAll(java.util.List)" class="member-name-link">replaceAll</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client">ReconnectLocation</a>> replacements)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Removes all currently configured <a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectLocation</code></a> values from the pool and replaces them with |
| the new set given.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shuffle()" class="member-name-link">shuffle</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Randomizes the order of the list of entries contained within the pool.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#size()" class="member-name-link">size</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>ReconnectLocationPool</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ReconnectLocationPool</span>()</div> |
| <div class="block">Creates an empty <a href="ReconnectLocationPool.html" title="class in org.apache.qpid.protonj2.client.util"><code>ReconnectLocationPool</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.util.List)"> |
| <h3>ReconnectLocationPool</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ReconnectLocationPool</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client">ReconnectLocation</a>> backups)</span></div> |
| <div class="block">Creates a new <a href="ReconnectLocationPool.html" title="class in org.apache.qpid.protonj2.client.util"><code>ReconnectLocationPool</code></a> with the provided <a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectLocation</code></a> values.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>backups</code> - a list of location where a reconnection attempt should be made.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="size()"> |
| <h3>size</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">size</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the current size of the entry pool.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isEmpty()"> |
| <h3>isEmpty</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if the entry pool is empty.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNext()"> |
| <h3>getNext</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client">ReconnectLocation</a></span> <span class="element-name">getNext</span>()</div> |
| <div class="block">Returns the next entry in the pool of entries. The entry will be shifted to the |
| end of the list and not be attempted again until the full list has been |
| returned once.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the next entry that should be used for a connection attempt.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shuffle()"> |
| <h3>shuffle</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">shuffle</span>()</div> |
| <div class="block">Randomizes the order of the list of entries contained within the pool.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(org.apache.qpid.protonj2.client.ReconnectLocation)"> |
| <h3>add</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">add</span><wbr><span class="parameters">(<a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client">ReconnectLocation</a> entry)</span></div> |
| <div class="block">Adds a new entry to the pool if not already contained within.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>entry</code> - The new <a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectLocation</code></a> to add to the pool.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addAll(java.util.List)"> |
| <h3>addAll</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addAll</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client">ReconnectLocation</a>> additions)</span></div> |
| <div class="block">Adds a list of new <a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectLocation</code></a> values to the pool if not already contained within.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>additions</code> - The new list of <a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectLocation</code></a> to add to the pool.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addFirst(org.apache.qpid.protonj2.client.ReconnectLocation)"> |
| <h3>addFirst</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addFirst</span><wbr><span class="parameters">(<a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client">ReconnectLocation</a> entry)</span></div> |
| <div class="block">Adds a new <a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectLocation</code></a> to the pool if not already contained within. |
| |
| The <a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectLocation</code></a> is added to the head of the pooled <a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectLocation</code></a> list and will be the |
| next value that is returned from the pool.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>entry</code> - The new <a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectLocation</code></a> to add to the pool.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="remove(org.apache.qpid.protonj2.client.ReconnectLocation)"> |
| <h3>remove</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">remove</span><wbr><span class="parameters">(<a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client">ReconnectLocation</a> entry)</span></div> |
| <div class="block">Remove a <a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectLocation</code></a> from the pool if present, otherwise has no effect.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>entry</code> - The <a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectLocation</code></a> to attempt to remove from the pool.</dd> |
| <dt>Returns:</dt> |
| <dd>true if the given <a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectLocation</code></a> was removed from the pool.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeAll()"> |
| <h3>removeAll</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">removeAll</span>()</div> |
| <div class="block">Removes all currently configured <a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectLocation</code></a> from the pool, no new <a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectLocation</code></a> values |
| will be served from this pool until new ones are added.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replaceAll(java.util.List)"> |
| <h3>replaceAll</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">replaceAll</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client">ReconnectLocation</a>> replacements)</span></div> |
| <div class="block">Removes all currently configured <a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectLocation</code></a> values from the pool and replaces them with |
| the new set given.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>replacements</code> - The new set of reconnect <a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectLocation</code></a> values to serve from this pool.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getList()"> |
| <h3>getList</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client">ReconnectLocation</a>></span> <span class="element-name">getList</span>()</div> |
| <div class="block">Gets the current list of <a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectLocation</code></a> values. The returned list is a copy.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a copy of the current list of <a href="../ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectLocation</code></a> values in the pool.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
