blob: 28ee2fb73866c176dc71e924adc229c77013bb7c [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TraversalStatus (Archiva Components :: Parent 3.0-SNAPSHOT API)</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="TraversalStatus (Archiva Components :: Parent 3.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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="class-use/TraversalStatus.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/archiva/components/graph/api/StandardRelationType.html" title="enum in org.apache.archiva.components.graph.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/archiva/components/graph/api/VisitError.html" title="class in org.apache.archiva.components.graph.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/archiva/components/graph/api/TraversalStatus.html" target="_top">Frames</a></li>
<li><a href="TraversalStatus.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.archiva.components.graph.api</div>
<h2 title="Class TraversalStatus" class="title">Class TraversalStatus&lt;V extends <a href="../../../../../../org/apache/archiva/components/graph/api/Node.html" title="interface in org.apache.archiva.components.graph.api">Node</a>&lt;V&gt;&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://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.archiva.components.graph.api.TraversalStatus&lt;V&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>V</code> - </dd>
</dl>
<hr>
<br>
<pre>public class <a href="../../../../../../src-html/org/apache/archiva/components/graph/api/TraversalStatus.html#line.30">TraversalStatus</a>&lt;V extends <a href="../../../../../../org/apache/archiva/components/graph/api/Node.html" title="interface in org.apache.archiva.components.graph.api">Node</a>&lt;V&gt;&gt;
extends <a href="https://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">This class gives information about the status of the graph traversal.
It holds the errors encountered and information about detected cycles.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/archiva/components/graph/api/TraversalStatus.html#TraversalStatus--">TraversalStatus</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/archiva/components/graph/api/TraversalStatus.html#addError-V-java.lang.Throwable-">addError</a></span>(<a href="../../../../../../org/apache/archiva/components/graph/api/TraversalStatus.html" title="type parameter in TraversalStatus">V</a>&nbsp;node,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;e)</code>
<div class="block">Add the given error to the list.</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/archiva/components/graph/api/TraversalStatus.html#getCycleCount--">getCycleCount</a></span>()</code>
<div class="block">Returns the number of detected cycles.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/archiva/components/graph/api/TraversalStatus.html" title="type parameter in TraversalStatus">V</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/archiva/components/graph/api/TraversalStatus.html#getCycleNodes--">getCycleNodes</a></span>()</code>
<div class="block">Returns the nodes, where cycles were detected.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/archiva/components/graph/api/VisitError.html" title="class in org.apache.archiva.components.graph.api">VisitError</a>&lt;<a href="../../../../../../org/apache/archiva/components/graph/api/TraversalStatus.html" title="type parameter in TraversalStatus">V</a>&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/archiva/components/graph/api/TraversalStatus.html#getErrorList--">getErrorList</a></span>()</code>
<div class="block">Returns the list of errors</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/archiva/components/graph/api/TraversalStatus.html#hasCycles--">hasCycles</a></span>()</code>
<div class="block">Returns true, if the traversal encountered a cycle.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/archiva/components/graph/api/TraversalStatus.html#hasErrors--">hasErrors</a></span>()</code>
<div class="block">Returns true, if there were errors while running the consumer function.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/archiva/components/graph/api/TraversalStatus.html#registerCycle-V-">registerCycle</a></span>(<a href="../../../../../../org/apache/archiva/components/graph/api/TraversalStatus.html" title="type parameter in TraversalStatus">V</a>&nbsp;node)</code>
<div class="block">Add another cycle to the counter</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://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="https://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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="TraversalStatus--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TraversalStatus</h4>
<pre>public&nbsp;<a href="../../../../../../src-html/org/apache/archiva/components/graph/api/TraversalStatus.html#line.37">TraversalStatus</a>()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getErrorList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getErrorList</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/archiva/components/graph/api/VisitError.html" title="class in org.apache.archiva.components.graph.api">VisitError</a>&lt;<a href="../../../../../../org/apache/archiva/components/graph/api/TraversalStatus.html" title="type parameter in TraversalStatus">V</a>&gt;&gt;&nbsp;<a href="../../../../../../src-html/org/apache/archiva/components/graph/api/TraversalStatus.html#line.47">getErrorList</a>()</pre>
<div class="block">Returns the list of errors</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a list of errors encountered while executing the consumer function on nodes</dd>
</dl>
</li>
</ul>
<a name="hasErrors--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasErrors</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../../src-html/org/apache/archiva/components/graph/api/TraversalStatus.html#line.57">hasErrors</a>()</pre>
<div class="block">Returns true, if there were errors while running the consumer function.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true, if errors occured on the consumer function, otherwise false</dd>
</dl>
</li>
</ul>
<a name="addError-org.apache.archiva.components.graph.api.Node-java.lang.Throwable-">
<!-- -->
</a><a name="addError-V-java.lang.Throwable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addError</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/archiva/components/graph/api/TraversalStatus.html#line.68">addError</a>(<a href="../../../../../../org/apache/archiva/components/graph/api/TraversalStatus.html" title="type parameter in TraversalStatus">V</a>&nbsp;node,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;e)</pre>
<div class="block">Add the given error to the list.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>node</code> - the node, where the error occurred</dd>
<dd><code>e</code> - the exception</dd>
</dl>
</li>
</ul>
<a name="registerCycle-org.apache.archiva.components.graph.api.Node-">
<!-- -->
</a><a name="registerCycle-V-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerCycle</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/archiva/components/graph/api/TraversalStatus.html#line.82">registerCycle</a>(<a href="../../../../../../org/apache/archiva/components/graph/api/TraversalStatus.html" title="type parameter in TraversalStatus">V</a>&nbsp;node)</pre>
<div class="block">Add another cycle to the counter</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>node</code> - </dd>
</dl>
</li>
</ul>
<a name="hasCycles--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasCycles</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../../src-html/org/apache/archiva/components/graph/api/TraversalStatus.html#line.97">hasCycles</a>()</pre>
<div class="block">Returns true, if the traversal encountered a cycle.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true, if cycle was encountered, otherwise false</dd>
</dl>
</li>
</ul>
<a name="getCycleCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCycleCount</h4>
<pre>public&nbsp;int&nbsp;<a href="../../../../../../src-html/org/apache/archiva/components/graph/api/TraversalStatus.html#line.107">getCycleCount</a>()</pre>
<div class="block">Returns the number of detected cycles.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of cycles</dd>
</dl>
</li>
</ul>
<a name="getCycleNodes--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getCycleNodes</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/archiva/components/graph/api/TraversalStatus.html" title="type parameter in TraversalStatus">V</a>&gt;&nbsp;<a href="../../../../../../src-html/org/apache/archiva/components/graph/api/TraversalStatus.html#line.118">getCycleNodes</a>()</pre>
<div class="block">Returns the nodes, where cycles were detected. The list may contain
duplicated entries, if cycles where detected on different paths.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of nodes where cycles were detected</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TraversalStatus.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/archiva/components/graph/api/StandardRelationType.html" title="enum in org.apache.archiva.components.graph.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/archiva/components/graph/api/VisitError.html" title="class in org.apache.archiva.components.graph.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/archiva/components/graph/api/TraversalStatus.html" target="_top">Frames</a></li>
<li><a href="TraversalStatus.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2019 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>