TwitterStreamFactory.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_161) on Thu Aug 16 18:54:30 JST 2018 -->
  6. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. <title>TwitterStreamFactory (twitter4j-stream 4.0.7 API)</title>
  8. <meta name="date" content="2018-08-16">
  9. <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
  10. <script type="text/javascript" src="../script.js"></script>
  11. </head>
  12. <body>
  13. <script type="text/javascript"><!--
  14. try {
  15. if (location.href.indexOf('is-external=true') == -1) {
  16. parent.document.title="TwitterStreamFactory (twitter4j-stream 4.0.7 API)";
  17. }
  18. }
  19. catch(err) {
  20. }
  21. //-->
  22. var methods = {"i0":10,"i1":10,"i2":10,"i3":9};
  23. var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  24. var altColor = "altColor";
  25. var rowColor = "rowColor";
  26. var tableTab = "tableTab";
  27. var activeTableTab = "activeTableTab";
  28. </script>
  29. <noscript>
  30. <div>JavaScript is disabled on your browser.</div>
  31. </noscript>
  32. <!-- ========= START OF TOP NAVBAR ======= -->
  33. <div class="topNav"><a name="navbar.top">
  34. <!-- -->
  35. </a>
  36. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  37. <a name="navbar.top.firstrow">
  38. <!-- -->
  39. </a>
  40. <ul class="navList" title="Navigation">
  41. <li><a href="../twitter4j/package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="class-use/TwitterStreamFactory.html">Use</a></li>
  44. <li><a href="package-tree.html">Tree</a></li>
  45. <li><a href="../deprecated-list.html">Deprecated</a></li>
  46. <li><a href="../index-all.html">Index</a></li>
  47. <li><a href="../help-doc.html">Help</a></li>
  48. </ul>
  49. </div>
  50. <div class="subNav">
  51. <ul class="navList">
  52. <li><a href="../twitter4j/TwitterStream.html" title="interface in twitter4j"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../twitter4j/UserStreamAdapter.html" title="class in twitter4j"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../index.html?twitter4j/TwitterStreamFactory.html" target="_top">Frames</a></li>
  57. <li><a href="TwitterStreamFactory.html" target="_top">No&nbsp;Frames</a></li>
  58. </ul>
  59. <ul class="navList" id="allclasses_navbar_top">
  60. <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61. </ul>
  62. <div>
  63. <script type="text/javascript"><!--
  64. allClassesLink = document.getElementById("allclasses_navbar_top");
  65. if(window==top) {
  66. allClassesLink.style.display = "block";
  67. }
  68. else {
  69. allClassesLink.style.display = "none";
  70. }
  71. //-->
  72. </script>
  73. </div>
  74. <div>
  75. <ul class="subNavList">
  76. <li>Summary:&nbsp;</li>
  77. <li>Nested&nbsp;|&nbsp;</li>
  78. <li>Field&nbsp;|&nbsp;</li>
  79. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  80. <li><a href="#method.summary">Method</a></li>
  81. </ul>
  82. <ul class="subNavList">
  83. <li>Detail:&nbsp;</li>
  84. <li>Field&nbsp;|&nbsp;</li>
  85. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  86. <li><a href="#method.detail">Method</a></li>
  87. </ul>
  88. </div>
  89. <a name="skip.navbar.top">
  90. <!-- -->
  91. </a></div>
  92. <!-- ========= END OF TOP NAVBAR ========= -->
  93. <!-- ======== START OF CLASS DATA ======== -->
  94. <div class="header">
  95. <div class="subTitle">twitter4j</div>
  96. <h2 title="Class TwitterStreamFactory" class="title">Class TwitterStreamFactory</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <ul class="inheritance">
  100. <li>java.lang.Object</li>
  101. <li>
  102. <ul class="inheritance">
  103. <li>twitter4j.TwitterStreamFactory</li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <dl>
  111. <dt>All Implemented Interfaces:</dt>
  112. <dd>java.io.Serializable</dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public final class <span class="typeNameLabel">TwitterStreamFactory</span>
  117. extends java.lang.Object
  118. implements java.io.Serializable</pre>
  119. <div class="block">A factory class for TwitterFactory.<br>
  120. An instance of this class is completely thread safe and can be re-used and used concurrently.<br>
  121. Note that TwitterStream is NOT compatible with Google App Engine as GAE is not capable of handling requests longer than 30 seconds.</div>
  122. <dl>
  123. <dt><span class="simpleTagLabel">Since:</span></dt>
  124. <dd>Twitter4J 2.1.0</dd>
  125. <dt><span class="simpleTagLabel">Author:</span></dt>
  126. <dd>Yusuke Yamamoto - yusuke at mac.com</dd>
  127. <dt><span class="seeLabel">See Also:</span></dt>
  128. <dd><a href="../serialized-form.html#twitter4j.TwitterStreamFactory">Serialized Form</a></dd>
  129. </dl>
  130. </li>
  131. </ul>
  132. </div>
  133. <div class="summary">
  134. <ul class="blockList">
  135. <li class="blockList">
  136. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  137. <ul class="blockList">
  138. <li class="blockList"><a name="constructor.summary">
  139. <!-- -->
  140. </a>
  141. <h3>Constructor Summary</h3>
  142. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  143. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  144. <tr>
  145. <th class="colOne" scope="col">Constructor and Description</th>
  146. </tr>
  147. <tr class="altColor">
  148. <td class="colOne"><code><span class="memberNameLink"><a href="../twitter4j/TwitterStreamFactory.html#TwitterStreamFactory--">TwitterStreamFactory</a></span>()</code>
  149. <div class="block">Creates a TwitterStreamFactory with the root configuration.</div>
  150. </td>
  151. </tr>
  152. <tr class="rowColor">
  153. <td class="colOne"><code><span class="memberNameLink"><a href="../twitter4j/TwitterStreamFactory.html#TwitterStreamFactory-twitter4j.conf.Configuration-">TwitterStreamFactory</a></span>(<a href="http://twitter4j.org/apidocs/twitter4j/conf/Configuration.html?is-external=true" title="class or interface in twitter4j.conf">Configuration</a>&nbsp;conf)</code>
  154. <div class="block">Creates a TwitterStreamFactory with the given configuration.</div>
  155. </td>
  156. </tr>
  157. <tr class="altColor">
  158. <td class="colOne"><code><span class="memberNameLink"><a href="../twitter4j/TwitterStreamFactory.html#TwitterStreamFactory-java.lang.String-">TwitterStreamFactory</a></span>(java.lang.String&nbsp;configTreePath)</code>
  159. <div class="block">Creates a TwitterStreamFactory with a specified config tree.</div>
  160. </td>
  161. </tr>
  162. </table>
  163. </li>
  164. </ul>
  165. <!-- ========== METHOD SUMMARY =========== -->
  166. <ul class="blockList">
  167. <li class="blockList"><a name="method.summary">
  168. <!-- -->
  169. </a>
  170. <h3>Method Summary</h3>
  171. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  172. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>
  173. <tr>
  174. <th class="colFirst" scope="col">Modifier and Type</th>
  175. <th class="colLast" scope="col">Method and Description</th>
  176. </tr>
  177. <tr id="i0" class="altColor">
  178. <td class="colFirst"><code><a href="../twitter4j/TwitterStream.html" title="interface in twitter4j">TwitterStream</a></code></td>
  179. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterStreamFactory.html#getInstance--">getInstance</a></span>()</code>
  180. <div class="block">Returns a instance associated with the configuration bound to this factory.</div>
  181. </td>
  182. </tr>
  183. <tr id="i1" class="rowColor">
  184. <td class="colFirst"><code><a href="../twitter4j/TwitterStream.html" title="interface in twitter4j">TwitterStream</a></code></td>
  185. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterStreamFactory.html#getInstance-twitter4j.auth.AccessToken-">getInstance</a></span>(<a href="http://twitter4j.org/apidocs/twitter4j/auth/AccessToken.html?is-external=true" title="class or interface in twitter4j.auth">AccessToken</a>&nbsp;accessToken)</code>
  186. <div class="block">Returns a OAuth Authenticated instance.<br>
  187. consumer key and consumer Secret must be provided by twitter4j.properties, or system properties.</div>
  188. </td>
  189. </tr>
  190. <tr id="i2" class="altColor">
  191. <td class="colFirst"><code><a href="../twitter4j/TwitterStream.html" title="interface in twitter4j">TwitterStream</a></code></td>
  192. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterStreamFactory.html#getInstance-twitter4j.auth.Authorization-">getInstance</a></span>(<a href="http://twitter4j.org/apidocs/twitter4j/auth/Authorization.html?is-external=true" title="class or interface in twitter4j.auth">Authorization</a>&nbsp;auth)</code>
  193. <div class="block">Returns a instance.</div>
  194. </td>
  195. </tr>
  196. <tr id="i3" class="rowColor">
  197. <td class="colFirst"><code>static <a href="../twitter4j/TwitterStream.html" title="interface in twitter4j">TwitterStream</a></code></td>
  198. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterStreamFactory.html#getSingleton--">getSingleton</a></span>()</code>
  199. <div class="block">Returns default singleton TwitterStream instance.</div>
  200. </td>
  201. </tr>
  202. </table>
  203. <ul class="blockList">
  204. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  205. <!-- -->
  206. </a>
  207. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  208. <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  209. </ul>
  210. </li>
  211. </ul>
  212. </li>
  213. </ul>
  214. </div>
  215. <div class="details">
  216. <ul class="blockList">
  217. <li class="blockList">
  218. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  219. <ul class="blockList">
  220. <li class="blockList"><a name="constructor.detail">
  221. <!-- -->
  222. </a>
  223. <h3>Constructor Detail</h3>
  224. <a name="TwitterStreamFactory--">
  225. <!-- -->
  226. </a>
  227. <ul class="blockList">
  228. <li class="blockList">
  229. <h4>TwitterStreamFactory</h4>
  230. <pre>public&nbsp;TwitterStreamFactory()</pre>
  231. <div class="block">Creates a TwitterStreamFactory with the root configuration.</div>
  232. </li>
  233. </ul>
  234. <a name="TwitterStreamFactory-twitter4j.conf.Configuration-">
  235. <!-- -->
  236. </a>
  237. <ul class="blockList">
  238. <li class="blockList">
  239. <h4>TwitterStreamFactory</h4>
  240. <pre>public&nbsp;TwitterStreamFactory(<a href="http://twitter4j.org/apidocs/twitter4j/conf/Configuration.html?is-external=true" title="class or interface in twitter4j.conf">Configuration</a>&nbsp;conf)</pre>
  241. <div class="block">Creates a TwitterStreamFactory with the given configuration.</div>
  242. <dl>
  243. <dt><span class="paramLabel">Parameters:</span></dt>
  244. <dd><code>conf</code> - the configuration to use</dd>
  245. <dt><span class="simpleTagLabel">Since:</span></dt>
  246. <dd>Twitter4J 2.1.1</dd>
  247. </dl>
  248. </li>
  249. </ul>
  250. <a name="TwitterStreamFactory-java.lang.String-">
  251. <!-- -->
  252. </a>
  253. <ul class="blockListLast">
  254. <li class="blockList">
  255. <h4>TwitterStreamFactory</h4>
  256. <pre>public&nbsp;TwitterStreamFactory(java.lang.String&nbsp;configTreePath)</pre>
  257. <div class="block">Creates a TwitterStreamFactory with a specified config tree.</div>
  258. <dl>
  259. <dt><span class="paramLabel">Parameters:</span></dt>
  260. <dd><code>configTreePath</code> - the path</dd>
  261. </dl>
  262. </li>
  263. </ul>
  264. </li>
  265. </ul>
  266. <!-- ============ METHOD DETAIL ========== -->
  267. <ul class="blockList">
  268. <li class="blockList"><a name="method.detail">
  269. <!-- -->
  270. </a>
  271. <h3>Method Detail</h3>
  272. <a name="getInstance--">
  273. <!-- -->
  274. </a>
  275. <ul class="blockList">
  276. <li class="blockList">
  277. <h4>getInstance</h4>
  278. <pre>public&nbsp;<a href="../twitter4j/TwitterStream.html" title="interface in twitter4j">TwitterStream</a>&nbsp;getInstance()</pre>
  279. <div class="block">Returns a instance associated with the configuration bound to this factory.</div>
  280. <dl>
  281. <dt><span class="returnLabel">Returns:</span></dt>
  282. <dd>default instance</dd>
  283. </dl>
  284. </li>
  285. </ul>
  286. <a name="getInstance-twitter4j.auth.AccessToken-">
  287. <!-- -->
  288. </a>
  289. <ul class="blockList">
  290. <li class="blockList">
  291. <h4>getInstance</h4>
  292. <pre>public&nbsp;<a href="../twitter4j/TwitterStream.html" title="interface in twitter4j">TwitterStream</a>&nbsp;getInstance(<a href="http://twitter4j.org/apidocs/twitter4j/auth/AccessToken.html?is-external=true" title="class or interface in twitter4j.auth">AccessToken</a>&nbsp;accessToken)</pre>
  293. <div class="block">Returns a OAuth Authenticated instance.<br>
  294. consumer key and consumer Secret must be provided by twitter4j.properties, or system properties.
  295. Unlike <a href="http://twitter4j.org/apidocs/twitter4j/auth/OAuthSupport.html?is-external=true#setOAuthAccessToken-twitter4j.auth.AccessToken-" title="class or interface in twitter4j.auth"><code>OAuthSupport.setOAuthAccessToken(twitter4j.auth.AccessToken)</code></a>, this factory method potentially returns a cached instance.</div>
  296. <dl>
  297. <dt><span class="paramLabel">Parameters:</span></dt>
  298. <dd><code>accessToken</code> - access token</dd>
  299. <dt><span class="returnLabel">Returns:</span></dt>
  300. <dd>an instance</dd>
  301. </dl>
  302. </li>
  303. </ul>
  304. <a name="getInstance-twitter4j.auth.Authorization-">
  305. <!-- -->
  306. </a>
  307. <ul class="blockList">
  308. <li class="blockList">
  309. <h4>getInstance</h4>
  310. <pre>public&nbsp;<a href="../twitter4j/TwitterStream.html" title="interface in twitter4j">TwitterStream</a>&nbsp;getInstance(<a href="http://twitter4j.org/apidocs/twitter4j/auth/Authorization.html?is-external=true" title="class or interface in twitter4j.auth">Authorization</a>&nbsp;auth)</pre>
  311. <div class="block">Returns a instance.</div>
  312. <dl>
  313. <dt><span class="paramLabel">Parameters:</span></dt>
  314. <dd><code>auth</code> - authorization object to be associated</dd>
  315. <dt><span class="returnLabel">Returns:</span></dt>
  316. <dd>an instance</dd>
  317. </dl>
  318. </li>
  319. </ul>
  320. <a name="getSingleton--">
  321. <!-- -->
  322. </a>
  323. <ul class="blockListLast">
  324. <li class="blockList">
  325. <h4>getSingleton</h4>
  326. <pre>public static&nbsp;<a href="../twitter4j/TwitterStream.html" title="interface in twitter4j">TwitterStream</a>&nbsp;getSingleton()</pre>
  327. <div class="block">Returns default singleton TwitterStream instance.</div>
  328. <dl>
  329. <dt><span class="returnLabel">Returns:</span></dt>
  330. <dd>default singleton TwitterStream instance</dd>
  331. <dt><span class="simpleTagLabel">Since:</span></dt>
  332. <dd>Twitter4J 2.2.4</dd>
  333. </dl>
  334. </li>
  335. </ul>
  336. </li>
  337. </ul>
  338. </li>
  339. </ul>
  340. </div>
  341. </div>
  342. <!-- ========= END OF CLASS DATA ========= -->
  343. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  344. <div class="bottomNav"><a name="navbar.bottom">
  345. <!-- -->
  346. </a>
  347. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  348. <a name="navbar.bottom.firstrow">
  349. <!-- -->
  350. </a>
  351. <ul class="navList" title="Navigation">
  352. <li><a href="../twitter4j/package-summary.html">Package</a></li>
  353. <li class="navBarCell1Rev">Class</li>
  354. <li><a href="class-use/TwitterStreamFactory.html">Use</a></li>
  355. <li><a href="package-tree.html">Tree</a></li>
  356. <li><a href="../deprecated-list.html">Deprecated</a></li>
  357. <li><a href="../index-all.html">Index</a></li>
  358. <li><a href="../help-doc.html">Help</a></li>
  359. </ul>
  360. </div>
  361. <div class="subNav">
  362. <ul class="navList">
  363. <li><a href="../twitter4j/TwitterStream.html" title="interface in twitter4j"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  364. <li><a href="../twitter4j/UserStreamAdapter.html" title="class in twitter4j"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  365. </ul>
  366. <ul class="navList">
  367. <li><a href="../index.html?twitter4j/TwitterStreamFactory.html" target="_top">Frames</a></li>
  368. <li><a href="TwitterStreamFactory.html" target="_top">No&nbsp;Frames</a></li>
  369. </ul>
  370. <ul class="navList" id="allclasses_navbar_bottom">
  371. <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
  372. </ul>
  373. <div>
  374. <script type="text/javascript"><!--
  375. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  376. if(window==top) {
  377. allClassesLink.style.display = "block";
  378. }
  379. else {
  380. allClassesLink.style.display = "none";
  381. }
  382. //-->
  383. </script>
  384. </div>
  385. <div>
  386. <ul class="subNavList">
  387. <li>Summary:&nbsp;</li>
  388. <li>Nested&nbsp;|&nbsp;</li>
  389. <li>Field&nbsp;|&nbsp;</li>
  390. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  391. <li><a href="#method.summary">Method</a></li>
  392. </ul>
  393. <ul class="subNavList">
  394. <li>Detail:&nbsp;</li>
  395. <li>Field&nbsp;|&nbsp;</li>
  396. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  397. <li><a href="#method.detail">Method</a></li>
  398. </ul>
  399. </div>
  400. <a name="skip.navbar.bottom">
  401. <!-- -->
  402. </a></div>
  403. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  404. <p class="legalCopy"><small>Copyright &#169; 2018. All Rights Reserved.</small></p>
  405. </body>
  406. </html>