TwitterFactory.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401
  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:14 JST 2018 -->
  6. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. <title>TwitterFactory (twitter4j-core 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="TwitterFactory (twitter4j-core 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="../overview-summary.html">Overview</a></li>
  42. <li><a href="package-summary.html">Package</a></li>
  43. <li class="navBarCell1Rev">Class</li>
  44. <li><a href="class-use/TwitterFactory.html">Use</a></li>
  45. <li><a href="package-tree.html">Tree</a></li>
  46. <li><a href="../deprecated-list.html">Deprecated</a></li>
  47. <li><a href="../index-all.html">Index</a></li>
  48. <li><a href="../help-doc.html">Help</a></li>
  49. </ul>
  50. </div>
  51. <div class="subNav">
  52. <ul class="navList">
  53. <li><a href="../twitter4j/TwitterException.html" title="class in twitter4j"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  54. <li><a href="../twitter4j/TwitterObjectFactory.html" title="class in twitter4j"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  55. </ul>
  56. <ul class="navList">
  57. <li><a href="../index.html?twitter4j/TwitterFactory.html" target="_top">Frames</a></li>
  58. <li><a href="TwitterFactory.html" target="_top">No&nbsp;Frames</a></li>
  59. </ul>
  60. <ul class="navList" id="allclasses_navbar_top">
  61. <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
  62. </ul>
  63. <div>
  64. <script type="text/javascript"><!--
  65. allClassesLink = document.getElementById("allclasses_navbar_top");
  66. if(window==top) {
  67. allClassesLink.style.display = "block";
  68. }
  69. else {
  70. allClassesLink.style.display = "none";
  71. }
  72. //-->
  73. </script>
  74. </div>
  75. <div>
  76. <ul class="subNavList">
  77. <li>Summary:&nbsp;</li>
  78. <li>Nested&nbsp;|&nbsp;</li>
  79. <li>Field&nbsp;|&nbsp;</li>
  80. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  81. <li><a href="#method.summary">Method</a></li>
  82. </ul>
  83. <ul class="subNavList">
  84. <li>Detail:&nbsp;</li>
  85. <li>Field&nbsp;|&nbsp;</li>
  86. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  87. <li><a href="#method.detail">Method</a></li>
  88. </ul>
  89. </div>
  90. <a name="skip.navbar.top">
  91. <!-- -->
  92. </a></div>
  93. <!-- ========= END OF TOP NAVBAR ========= -->
  94. <!-- ======== START OF CLASS DATA ======== -->
  95. <div class="header">
  96. <div class="subTitle">twitter4j</div>
  97. <h2 title="Class TwitterFactory" class="title">Class TwitterFactory</h2>
  98. </div>
  99. <div class="contentContainer">
  100. <ul class="inheritance">
  101. <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>
  102. <li>
  103. <ul class="inheritance">
  104. <li>twitter4j.TwitterFactory</li>
  105. </ul>
  106. </li>
  107. </ul>
  108. <div class="description">
  109. <ul class="blockList">
  110. <li class="blockList">
  111. <dl>
  112. <dt>All Implemented Interfaces:</dt>
  113. <dd><a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
  114. </dl>
  115. <hr>
  116. <br>
  117. <pre>public class <span class="typeNameLabel">TwitterFactory</span>
  118. 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>
  119. implements <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
  120. <div class="block">A factory class for Twitter.
  121. <br>An instance of this class is completely thread safe and can be re-used and used concurrently.</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.TwitterFactory">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/TwitterFactory.html#TwitterFactory--">TwitterFactory</a></span>()</code>
  149. <div class="block">Creates a TwitterFactory with the root configuration.</div>
  150. </td>
  151. </tr>
  152. <tr class="rowColor">
  153. <td class="colOne"><code><span class="memberNameLink"><a href="../twitter4j/TwitterFactory.html#TwitterFactory-twitter4j.conf.Configuration-">TwitterFactory</a></span>(<a href="../twitter4j/conf/Configuration.html" title="interface in twitter4j.conf">Configuration</a>&nbsp;conf)</code>
  154. <div class="block">Creates a TwitterFactory with the given configuration.</div>
  155. </td>
  156. </tr>
  157. <tr class="altColor">
  158. <td class="colOne"><code><span class="memberNameLink"><a href="../twitter4j/TwitterFactory.html#TwitterFactory-java.lang.String-">TwitterFactory</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>&nbsp;configTreePath)</code>
  159. <div class="block">Creates a TwitterFactory 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/Twitter.html" title="interface in twitter4j">Twitter</a></code></td>
  179. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterFactory.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/Twitter.html" title="interface in twitter4j">Twitter</a></code></td>
  185. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterFactory.html#getInstance-twitter4j.auth.AccessToken-">getInstance</a></span>(<a href="../twitter4j/auth/AccessToken.html" title="class 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.<br>
  188. Unlike <a href="../twitter4j/auth/OAuthSupport.html#setOAuthAccessToken-twitter4j.auth.AccessToken-"><code>OAuthSupport.setOAuthAccessToken(twitter4j.auth.AccessToken)</code></a>, this factory method potentially returns a cached instance.</div>
  189. </td>
  190. </tr>
  191. <tr id="i2" class="altColor">
  192. <td class="colFirst"><code><a href="../twitter4j/Twitter.html" title="interface in twitter4j">Twitter</a></code></td>
  193. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterFactory.html#getInstance-twitter4j.auth.Authorization-">getInstance</a></span>(<a href="../twitter4j/auth/Authorization.html" title="interface in twitter4j.auth">Authorization</a>&nbsp;auth)</code>&nbsp;</td>
  194. </tr>
  195. <tr id="i3" class="rowColor">
  196. <td class="colFirst"><code>static <a href="../twitter4j/Twitter.html" title="interface in twitter4j">Twitter</a></code></td>
  197. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterFactory.html#getSingleton--">getSingleton</a></span>()</code>
  198. <div class="block">Returns default singleton Twitter instance.</div>
  199. </td>
  200. </tr>
  201. </table>
  202. <ul class="blockList">
  203. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  204. <!-- -->
  205. </a>
  206. <h3>Methods inherited from class&nbsp;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>
  207. <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>, <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>
  208. </ul>
  209. </li>
  210. </ul>
  211. </li>
  212. </ul>
  213. </div>
  214. <div class="details">
  215. <ul class="blockList">
  216. <li class="blockList">
  217. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  218. <ul class="blockList">
  219. <li class="blockList"><a name="constructor.detail">
  220. <!-- -->
  221. </a>
  222. <h3>Constructor Detail</h3>
  223. <a name="TwitterFactory--">
  224. <!-- -->
  225. </a>
  226. <ul class="blockList">
  227. <li class="blockList">
  228. <h4>TwitterFactory</h4>
  229. <pre>public&nbsp;TwitterFactory()</pre>
  230. <div class="block">Creates a TwitterFactory with the root configuration.</div>
  231. </li>
  232. </ul>
  233. <a name="TwitterFactory-twitter4j.conf.Configuration-">
  234. <!-- -->
  235. </a>
  236. <ul class="blockList">
  237. <li class="blockList">
  238. <h4>TwitterFactory</h4>
  239. <pre>public&nbsp;TwitterFactory(<a href="../twitter4j/conf/Configuration.html" title="interface in twitter4j.conf">Configuration</a>&nbsp;conf)</pre>
  240. <div class="block">Creates a TwitterFactory with the given configuration.</div>
  241. <dl>
  242. <dt><span class="paramLabel">Parameters:</span></dt>
  243. <dd><code>conf</code> - the configuration to use</dd>
  244. <dt><span class="simpleTagLabel">Since:</span></dt>
  245. <dd>Twitter4J 2.1.1</dd>
  246. </dl>
  247. </li>
  248. </ul>
  249. <a name="TwitterFactory-java.lang.String-">
  250. <!-- -->
  251. </a>
  252. <ul class="blockListLast">
  253. <li class="blockList">
  254. <h4>TwitterFactory</h4>
  255. <pre>public&nbsp;TwitterFactory(<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>&nbsp;configTreePath)</pre>
  256. <div class="block">Creates a TwitterFactory with a specified config tree</div>
  257. <dl>
  258. <dt><span class="paramLabel">Parameters:</span></dt>
  259. <dd><code>configTreePath</code> - the path</dd>
  260. </dl>
  261. </li>
  262. </ul>
  263. </li>
  264. </ul>
  265. <!-- ============ METHOD DETAIL ========== -->
  266. <ul class="blockList">
  267. <li class="blockList"><a name="method.detail">
  268. <!-- -->
  269. </a>
  270. <h3>Method Detail</h3>
  271. <a name="getInstance--">
  272. <!-- -->
  273. </a>
  274. <ul class="blockList">
  275. <li class="blockList">
  276. <h4>getInstance</h4>
  277. <pre>public&nbsp;<a href="../twitter4j/Twitter.html" title="interface in twitter4j">Twitter</a>&nbsp;getInstance()</pre>
  278. <div class="block">Returns a instance associated with the configuration bound to this factory.</div>
  279. <dl>
  280. <dt><span class="returnLabel">Returns:</span></dt>
  281. <dd>default singleton instance</dd>
  282. </dl>
  283. </li>
  284. </ul>
  285. <a name="getInstance-twitter4j.auth.AccessToken-">
  286. <!-- -->
  287. </a>
  288. <ul class="blockList">
  289. <li class="blockList">
  290. <h4>getInstance</h4>
  291. <pre>public&nbsp;<a href="../twitter4j/Twitter.html" title="interface in twitter4j">Twitter</a>&nbsp;getInstance(<a href="../twitter4j/auth/AccessToken.html" title="class in twitter4j.auth">AccessToken</a>&nbsp;accessToken)</pre>
  292. <div class="block">Returns a OAuth Authenticated instance.<br>
  293. consumer key and consumer Secret must be provided by twitter4j.properties, or system properties.<br>
  294. Unlike <a href="../twitter4j/auth/OAuthSupport.html#setOAuthAccessToken-twitter4j.auth.AccessToken-"><code>OAuthSupport.setOAuthAccessToken(twitter4j.auth.AccessToken)</code></a>, this factory method potentially returns a cached instance.</div>
  295. <dl>
  296. <dt><span class="paramLabel">Parameters:</span></dt>
  297. <dd><code>accessToken</code> - access token</dd>
  298. <dt><span class="returnLabel">Returns:</span></dt>
  299. <dd>an instance</dd>
  300. <dt><span class="simpleTagLabel">Since:</span></dt>
  301. <dd>Twitter4J 2.1.9</dd>
  302. </dl>
  303. </li>
  304. </ul>
  305. <a name="getInstance-twitter4j.auth.Authorization-">
  306. <!-- -->
  307. </a>
  308. <ul class="blockList">
  309. <li class="blockList">
  310. <h4>getInstance</h4>
  311. <pre>public&nbsp;<a href="../twitter4j/Twitter.html" title="interface in twitter4j">Twitter</a>&nbsp;getInstance(<a href="../twitter4j/auth/Authorization.html" title="interface in twitter4j.auth">Authorization</a>&nbsp;auth)</pre>
  312. </li>
  313. </ul>
  314. <a name="getSingleton--">
  315. <!-- -->
  316. </a>
  317. <ul class="blockListLast">
  318. <li class="blockList">
  319. <h4>getSingleton</h4>
  320. <pre>public static&nbsp;<a href="../twitter4j/Twitter.html" title="interface in twitter4j">Twitter</a>&nbsp;getSingleton()</pre>
  321. <div class="block">Returns default singleton Twitter instance.</div>
  322. <dl>
  323. <dt><span class="returnLabel">Returns:</span></dt>
  324. <dd>default singleton Twitter instance</dd>
  325. <dt><span class="simpleTagLabel">Since:</span></dt>
  326. <dd>Twitter4J 2.2.4</dd>
  327. </dl>
  328. </li>
  329. </ul>
  330. </li>
  331. </ul>
  332. </li>
  333. </ul>
  334. </div>
  335. </div>
  336. <!-- ========= END OF CLASS DATA ========= -->
  337. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  338. <div class="bottomNav"><a name="navbar.bottom">
  339. <!-- -->
  340. </a>
  341. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  342. <a name="navbar.bottom.firstrow">
  343. <!-- -->
  344. </a>
  345. <ul class="navList" title="Navigation">
  346. <li><a href="../overview-summary.html">Overview</a></li>
  347. <li><a href="package-summary.html">Package</a></li>
  348. <li class="navBarCell1Rev">Class</li>
  349. <li><a href="class-use/TwitterFactory.html">Use</a></li>
  350. <li><a href="package-tree.html">Tree</a></li>
  351. <li><a href="../deprecated-list.html">Deprecated</a></li>
  352. <li><a href="../index-all.html">Index</a></li>
  353. <li><a href="../help-doc.html">Help</a></li>
  354. </ul>
  355. </div>
  356. <div class="subNav">
  357. <ul class="navList">
  358. <li><a href="../twitter4j/TwitterException.html" title="class in twitter4j"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  359. <li><a href="../twitter4j/TwitterObjectFactory.html" title="class in twitter4j"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  360. </ul>
  361. <ul class="navList">
  362. <li><a href="../index.html?twitter4j/TwitterFactory.html" target="_top">Frames</a></li>
  363. <li><a href="TwitterFactory.html" target="_top">No&nbsp;Frames</a></li>
  364. </ul>
  365. <ul class="navList" id="allclasses_navbar_bottom">
  366. <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
  367. </ul>
  368. <div>
  369. <script type="text/javascript"><!--
  370. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  371. if(window==top) {
  372. allClassesLink.style.display = "block";
  373. }
  374. else {
  375. allClassesLink.style.display = "none";
  376. }
  377. //-->
  378. </script>
  379. </div>
  380. <div>
  381. <ul class="subNavList">
  382. <li>Summary:&nbsp;</li>
  383. <li>Nested&nbsp;|&nbsp;</li>
  384. <li>Field&nbsp;|&nbsp;</li>
  385. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  386. <li><a href="#method.summary">Method</a></li>
  387. </ul>
  388. <ul class="subNavList">
  389. <li>Detail:&nbsp;</li>
  390. <li>Field&nbsp;|&nbsp;</li>
  391. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  392. <li><a href="#method.detail">Method</a></li>
  393. </ul>
  394. </div>
  395. <a name="skip.navbar.bottom">
  396. <!-- -->
  397. </a></div>
  398. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  399. <p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
  400. </body>
  401. </html>