NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/MultiInfoItemsCollector.html

358 lines
20 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>MultiInfoItemsCollector (NewPipeExtractor v0.22.0)</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="MultiInfoItemsCollector (NewPipeExtractor v0.22.0)";
}
}
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><a href="../../../../org/schabi/newpipe/extractor/MetaInfo.html" title="class in org.schabi.newpipe.extractor"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/schabi/newpipe/extractor/NewPipe.html" title="class in org.schabi.newpipe.extractor"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/schabi/newpipe/extractor/MultiInfoItemsCollector.html" target="_top">Frames</a></li>
<li><a href="MultiInfoItemsCollector.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.schabi.newpipe.extractor</div>
<h2 title="Class MultiInfoItemsCollector" class="title">Class MultiInfoItemsCollector</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><a href="../../../../org/schabi/newpipe/extractor/InfoItemsCollector.html" title="class in org.schabi.newpipe.extractor">org.schabi.newpipe.extractor.InfoItemsCollector</a>&lt;<a href="../../../../org/schabi/newpipe/extractor/InfoItem.html" title="class in org.schabi.newpipe.extractor">InfoItem</a>,<a href="../../../../org/schabi/newpipe/extractor/InfoItemExtractor.html" title="interface in org.schabi.newpipe.extractor">InfoItemExtractor</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.schabi.newpipe.extractor.MultiInfoItemsCollector</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/schabi/newpipe/extractor/Collector.html" title="interface in org.schabi.newpipe.extractor">Collector</a>&lt;<a href="../../../../org/schabi/newpipe/extractor/InfoItem.html" title="class in org.schabi.newpipe.extractor">InfoItem</a>,<a href="../../../../org/schabi/newpipe/extractor/InfoItemExtractor.html" title="interface in org.schabi.newpipe.extractor">InfoItemExtractor</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">MultiInfoItemsCollector</span>
extends <a href="../../../../org/schabi/newpipe/extractor/InfoItemsCollector.html" title="class in org.schabi.newpipe.extractor">InfoItemsCollector</a>&lt;<a href="../../../../org/schabi/newpipe/extractor/InfoItem.html" title="class in org.schabi.newpipe.extractor">InfoItem</a>,<a href="../../../../org/schabi/newpipe/extractor/InfoItemExtractor.html" title="interface in org.schabi.newpipe.extractor">InfoItemExtractor</a>&gt;</pre>
<div class="block">A collector that can handle many extractor types, to be used when a list contains items of
different types (e.g. search)
<p>
This collector can handle the following extractor types:
<ul>
<li><a href="../../../../org/schabi/newpipe/extractor/stream/StreamInfoItemExtractor.html" title="interface in org.schabi.newpipe.extractor.stream"><code>StreamInfoItemExtractor</code></a></li>
<li><a href="../../../../org/schabi/newpipe/extractor/channel/ChannelInfoItemExtractor.html" title="interface in org.schabi.newpipe.extractor.channel"><code>ChannelInfoItemExtractor</code></a></li>
<li><a href="../../../../org/schabi/newpipe/extractor/playlist/PlaylistInfoItemExtractor.html" title="interface in org.schabi.newpipe.extractor.playlist"><code>PlaylistInfoItemExtractor</code></a></li>
</ul>
Calling <a href="../../../../org/schabi/newpipe/extractor/MultiInfoItemsCollector.html#extract-org.schabi.newpipe.extractor.InfoItemExtractor-"><code>extract(InfoItemExtractor)</code></a> or <a href="../../../../org/schabi/newpipe/extractor/InfoItemsCollector.html#commit-E-"><code>InfoItemsCollector.commit(InfoItemExtractor)</code></a> with any
other extractor type will raise an exception.</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/schabi/newpipe/extractor/MultiInfoItemsCollector.html#MultiInfoItemsCollector-int-">MultiInfoItemsCollector</a></span>(int&nbsp;serviceId)</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><a href="../../../../org/schabi/newpipe/extractor/InfoItem.html" title="class in org.schabi.newpipe.extractor">InfoItem</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/schabi/newpipe/extractor/MultiInfoItemsCollector.html#extract-org.schabi.newpipe.extractor.InfoItemExtractor-">extract</a></span>(<a href="../../../../org/schabi/newpipe/extractor/InfoItemExtractor.html" title="interface in org.schabi.newpipe.extractor">InfoItemExtractor</a>&nbsp;extractor)</code>
<div class="block">Try to extract the item from an extractor without adding it to the collection</div>
</td>
</tr>
<tr id="i1" 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="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/schabi/newpipe/extractor/MultiInfoItemsCollector.html#getErrors--">getErrors</a></span>()</code>
<div class="block">Get all errors</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/schabi/newpipe/extractor/MultiInfoItemsCollector.html#reset--">reset</a></span>()</code>
<div class="block">Reset all collected items and errors</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.schabi.newpipe.extractor.InfoItemsCollector">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.schabi.newpipe.extractor.<a href="../../../../org/schabi/newpipe/extractor/InfoItemsCollector.html" title="class in org.schabi.newpipe.extractor">InfoItemsCollector</a></h3>
<code><a href="../../../../org/schabi/newpipe/extractor/InfoItemsCollector.html#addError-java.lang.Exception-">addError</a>, <a href="../../../../org/schabi/newpipe/extractor/InfoItemsCollector.html#addItem-I-">addItem</a>, <a href="../../../../org/schabi/newpipe/extractor/InfoItemsCollector.html#commit-E-">commit</a>, <a href="../../../../org/schabi/newpipe/extractor/InfoItemsCollector.html#getItems--">getItems</a>, <a href="../../../../org/schabi/newpipe/extractor/InfoItemsCollector.html#getServiceId--">getServiceId</a></code></li>
</ul>
<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="MultiInfoItemsCollector-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MultiInfoItemsCollector</h4>
<pre>public&nbsp;MultiInfoItemsCollector(int&nbsp;serviceId)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getErrors--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getErrors</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="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&gt;&nbsp;getErrors()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/schabi/newpipe/extractor/Collector.html#getErrors--">Collector</a></code></span></div>
<div class="block">Get all errors</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/schabi/newpipe/extractor/Collector.html#getErrors--">getErrors</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/schabi/newpipe/extractor/Collector.html" title="interface in org.schabi.newpipe.extractor">Collector</a>&lt;<a href="../../../../org/schabi/newpipe/extractor/InfoItem.html" title="class in org.schabi.newpipe.extractor">InfoItem</a>,<a href="../../../../org/schabi/newpipe/extractor/InfoItemExtractor.html" title="interface in org.schabi.newpipe.extractor">InfoItemExtractor</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/schabi/newpipe/extractor/InfoItemsCollector.html#getErrors--">getErrors</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/schabi/newpipe/extractor/InfoItemsCollector.html" title="class in org.schabi.newpipe.extractor">InfoItemsCollector</a>&lt;<a href="../../../../org/schabi/newpipe/extractor/InfoItem.html" title="class in org.schabi.newpipe.extractor">InfoItem</a>,<a href="../../../../org/schabi/newpipe/extractor/InfoItemExtractor.html" title="interface in org.schabi.newpipe.extractor">InfoItemExtractor</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the errors</dd>
</dl>
</li>
</ul>
<a name="reset--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre>public&nbsp;void&nbsp;reset()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/schabi/newpipe/extractor/Collector.html#reset--">Collector</a></code></span></div>
<div class="block">Reset all collected items and errors</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/schabi/newpipe/extractor/Collector.html#reset--">reset</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/schabi/newpipe/extractor/Collector.html" title="interface in org.schabi.newpipe.extractor">Collector</a>&lt;<a href="../../../../org/schabi/newpipe/extractor/InfoItem.html" title="class in org.schabi.newpipe.extractor">InfoItem</a>,<a href="../../../../org/schabi/newpipe/extractor/InfoItemExtractor.html" title="interface in org.schabi.newpipe.extractor">InfoItemExtractor</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/schabi/newpipe/extractor/InfoItemsCollector.html#reset--">reset</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/schabi/newpipe/extractor/InfoItemsCollector.html" title="class in org.schabi.newpipe.extractor">InfoItemsCollector</a>&lt;<a href="../../../../org/schabi/newpipe/extractor/InfoItem.html" title="class in org.schabi.newpipe.extractor">InfoItem</a>,<a href="../../../../org/schabi/newpipe/extractor/InfoItemExtractor.html" title="interface in org.schabi.newpipe.extractor">InfoItemExtractor</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="extract-org.schabi.newpipe.extractor.InfoItemExtractor-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>extract</h4>
<pre>public&nbsp;<a href="../../../../org/schabi/newpipe/extractor/InfoItem.html" title="class in org.schabi.newpipe.extractor">InfoItem</a>&nbsp;extract(<a href="../../../../org/schabi/newpipe/extractor/InfoItemExtractor.html" title="interface in org.schabi.newpipe.extractor">InfoItemExtractor</a>&nbsp;extractor)
throws <a href="../../../../org/schabi/newpipe/extractor/exceptions/ParsingException.html" title="class in org.schabi.newpipe.extractor.exceptions">ParsingException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/schabi/newpipe/extractor/Collector.html#extract-E-">Collector</a></code></span></div>
<div class="block">Try to extract the item from an extractor without adding it to the collection</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>extractor</code> - the extractor to use</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the item</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/schabi/newpipe/extractor/exceptions/ParsingException.html" title="class in org.schabi.newpipe.extractor.exceptions">ParsingException</a></code> - thrown if there is an error extracting the
<b>required</b> fields of the item.</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/schabi/newpipe/extractor/MetaInfo.html" title="class in org.schabi.newpipe.extractor"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/schabi/newpipe/extractor/NewPipe.html" title="class in org.schabi.newpipe.extractor"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/schabi/newpipe/extractor/MultiInfoItemsCollector.html" target="_top">Frames</a></li>
<li><a href="MultiInfoItemsCollector.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 ======= -->
</body>
</html>