URLEntity.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358
  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>URLEntity (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="URLEntity (twitter4j-core 4.0.7 API)";
  17. }
  18. }
  19. catch(err) {
  20. }
  21. //-->
  22. var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6};
  23. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/URLEntity.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/UploadedMedia.html" title="class in twitter4j"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  54. <li><a href="../twitter4j/User.html" title="interface in twitter4j"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  55. </ul>
  56. <ul class="navList">
  57. <li><a href="../index.html?twitter4j/URLEntity.html" target="_top">Frames</a></li>
  58. <li><a href="URLEntity.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>Constr&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>Constr&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="Interface URLEntity" class="title">Interface URLEntity</h2>
  98. </div>
  99. <div class="contentContainer">
  100. <div class="description">
  101. <ul class="blockList">
  102. <li class="blockList">
  103. <dl>
  104. <dt>All Superinterfaces:</dt>
  105. <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>, <a href="../twitter4j/TweetEntity.html" title="interface in twitter4j">TweetEntity</a></dd>
  106. </dl>
  107. <dl>
  108. <dt>All Known Subinterfaces:</dt>
  109. <dd><a href="../twitter4j/MediaEntity.html" title="interface in twitter4j">MediaEntity</a></dd>
  110. </dl>
  111. <dl>
  112. <dt>All Known Implementing Classes:</dt>
  113. <dd><a href="../twitter4j/MediaEntityJSONImpl.html" title="class in twitter4j">MediaEntityJSONImpl</a></dd>
  114. </dl>
  115. <hr>
  116. <br>
  117. <pre>public interface <span class="typeNameLabel">URLEntity</span>
  118. extends <a href="../twitter4j/TweetEntity.html" title="interface in twitter4j">TweetEntity</a>, <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>
  119. <div class="block">A data interface representing one single URL entity.</div>
  120. <dl>
  121. <dt><span class="simpleTagLabel">Since:</span></dt>
  122. <dd>Twitter4J 2.1.9</dd>
  123. <dt><span class="simpleTagLabel">Author:</span></dt>
  124. <dd>Mocel - mocel at guma.jp</dd>
  125. </dl>
  126. </li>
  127. </ul>
  128. </div>
  129. <div class="summary">
  130. <ul class="blockList">
  131. <li class="blockList">
  132. <!-- ========== METHOD SUMMARY =========== -->
  133. <ul class="blockList">
  134. <li class="blockList"><a name="method.summary">
  135. <!-- -->
  136. </a>
  137. <h3>Method Summary</h3>
  138. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  139. <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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  140. <tr>
  141. <th class="colFirst" scope="col">Modifier and Type</th>
  142. <th class="colLast" scope="col">Method and Description</th>
  143. </tr>
  144. <tr id="i0" class="altColor">
  145. <td class="colFirst"><code><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></code></td>
  146. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/URLEntity.html#getDisplayURL--">getDisplayURL</a></span>()</code>
  147. <div class="block">Returns the display URL if mentioned URL is shorten.</div>
  148. </td>
  149. </tr>
  150. <tr id="i1" class="rowColor">
  151. <td class="colFirst"><code>int</code></td>
  152. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/URLEntity.html#getEnd--">getEnd</a></span>()</code>
  153. <div class="block">Returns the index of the end character of the URL mentioned in the tweet.</div>
  154. </td>
  155. </tr>
  156. <tr id="i2" class="altColor">
  157. <td class="colFirst"><code><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></code></td>
  158. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/URLEntity.html#getExpandedURL--">getExpandedURL</a></span>()</code>
  159. <div class="block">Returns the expanded URL if mentioned URL is shorten.</div>
  160. </td>
  161. </tr>
  162. <tr id="i3" class="rowColor">
  163. <td class="colFirst"><code>int</code></td>
  164. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/URLEntity.html#getStart--">getStart</a></span>()</code>
  165. <div class="block">Returns the index of the start character of the URL mentioned in the tweet.</div>
  166. </td>
  167. </tr>
  168. <tr id="i4" class="altColor">
  169. <td class="colFirst"><code><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></code></td>
  170. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/URLEntity.html#getText--">getText</a></span>()</code>
  171. <div class="block">Returns the URL mentioned in the tweet.<br>
  172. This method implementation is to meet TweetEntity interface and the behavior is equivalent to <a href="../twitter4j/URLEntity.html#getURL--"><code>getURL()</code></a></div>
  173. </td>
  174. </tr>
  175. <tr id="i5" class="rowColor">
  176. <td class="colFirst"><code><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></code></td>
  177. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/URLEntity.html#getURL--">getURL</a></span>()</code>
  178. <div class="block">Returns the URL mentioned in the tweet.</div>
  179. </td>
  180. </tr>
  181. </table>
  182. </li>
  183. </ul>
  184. </li>
  185. </ul>
  186. </div>
  187. <div class="details">
  188. <ul class="blockList">
  189. <li class="blockList">
  190. <!-- ============ METHOD DETAIL ========== -->
  191. <ul class="blockList">
  192. <li class="blockList"><a name="method.detail">
  193. <!-- -->
  194. </a>
  195. <h3>Method Detail</h3>
  196. <a name="getText--">
  197. <!-- -->
  198. </a>
  199. <ul class="blockList">
  200. <li class="blockList">
  201. <h4>getText</h4>
  202. <pre><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;getText()</pre>
  203. <div class="block">Returns the URL mentioned in the tweet.<br>
  204. This method implementation is to meet TweetEntity interface and the behavior is equivalent to <a href="../twitter4j/URLEntity.html#getURL--"><code>getURL()</code></a></div>
  205. <dl>
  206. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  207. <dd><code><a href="../twitter4j/TweetEntity.html#getText--">getText</a></code>&nbsp;in interface&nbsp;<code><a href="../twitter4j/TweetEntity.html" title="interface in twitter4j">TweetEntity</a></code></dd>
  208. <dt><span class="returnLabel">Returns:</span></dt>
  209. <dd>the mentioned URL</dd>
  210. </dl>
  211. </li>
  212. </ul>
  213. <a name="getURL--">
  214. <!-- -->
  215. </a>
  216. <ul class="blockList">
  217. <li class="blockList">
  218. <h4>getURL</h4>
  219. <pre><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;getURL()</pre>
  220. <div class="block">Returns the URL mentioned in the tweet.</div>
  221. <dl>
  222. <dt><span class="returnLabel">Returns:</span></dt>
  223. <dd>the mentioned URL</dd>
  224. </dl>
  225. </li>
  226. </ul>
  227. <a name="getExpandedURL--">
  228. <!-- -->
  229. </a>
  230. <ul class="blockList">
  231. <li class="blockList">
  232. <h4>getExpandedURL</h4>
  233. <pre><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;getExpandedURL()</pre>
  234. <div class="block">Returns the expanded URL if mentioned URL is shorten.</div>
  235. <dl>
  236. <dt><span class="returnLabel">Returns:</span></dt>
  237. <dd>the expanded URL if mentioned URL is shorten, or null if no shorten URL was mentioned.</dd>
  238. </dl>
  239. </li>
  240. </ul>
  241. <a name="getDisplayURL--">
  242. <!-- -->
  243. </a>
  244. <ul class="blockList">
  245. <li class="blockList">
  246. <h4>getDisplayURL</h4>
  247. <pre><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;getDisplayURL()</pre>
  248. <div class="block">Returns the display URL if mentioned URL is shorten.</div>
  249. <dl>
  250. <dt><span class="returnLabel">Returns:</span></dt>
  251. <dd>the display URL if mentioned URL is shorten, or null if no shorten URL was mentioned.</dd>
  252. </dl>
  253. </li>
  254. </ul>
  255. <a name="getStart--">
  256. <!-- -->
  257. </a>
  258. <ul class="blockList">
  259. <li class="blockList">
  260. <h4>getStart</h4>
  261. <pre>int&nbsp;getStart()</pre>
  262. <div class="block">Returns the index of the start character of the URL mentioned in the tweet.</div>
  263. <dl>
  264. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  265. <dd><code><a href="../twitter4j/TweetEntity.html#getStart--">getStart</a></code>&nbsp;in interface&nbsp;<code><a href="../twitter4j/TweetEntity.html" title="interface in twitter4j">TweetEntity</a></code></dd>
  266. <dt><span class="returnLabel">Returns:</span></dt>
  267. <dd>the index of the start character of the URL mentioned in the tweet</dd>
  268. </dl>
  269. </li>
  270. </ul>
  271. <a name="getEnd--">
  272. <!-- -->
  273. </a>
  274. <ul class="blockListLast">
  275. <li class="blockList">
  276. <h4>getEnd</h4>
  277. <pre>int&nbsp;getEnd()</pre>
  278. <div class="block">Returns the index of the end character of the URL mentioned in the tweet.</div>
  279. <dl>
  280. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  281. <dd><code><a href="../twitter4j/TweetEntity.html#getEnd--">getEnd</a></code>&nbsp;in interface&nbsp;<code><a href="../twitter4j/TweetEntity.html" title="interface in twitter4j">TweetEntity</a></code></dd>
  282. <dt><span class="returnLabel">Returns:</span></dt>
  283. <dd>the index of the end character of the URL mentioned in the tweet</dd>
  284. </dl>
  285. </li>
  286. </ul>
  287. </li>
  288. </ul>
  289. </li>
  290. </ul>
  291. </div>
  292. </div>
  293. <!-- ========= END OF CLASS DATA ========= -->
  294. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  295. <div class="bottomNav"><a name="navbar.bottom">
  296. <!-- -->
  297. </a>
  298. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  299. <a name="navbar.bottom.firstrow">
  300. <!-- -->
  301. </a>
  302. <ul class="navList" title="Navigation">
  303. <li><a href="../overview-summary.html">Overview</a></li>
  304. <li><a href="package-summary.html">Package</a></li>
  305. <li class="navBarCell1Rev">Class</li>
  306. <li><a href="class-use/URLEntity.html">Use</a></li>
  307. <li><a href="package-tree.html">Tree</a></li>
  308. <li><a href="../deprecated-list.html">Deprecated</a></li>
  309. <li><a href="../index-all.html">Index</a></li>
  310. <li><a href="../help-doc.html">Help</a></li>
  311. </ul>
  312. </div>
  313. <div class="subNav">
  314. <ul class="navList">
  315. <li><a href="../twitter4j/UploadedMedia.html" title="class in twitter4j"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  316. <li><a href="../twitter4j/User.html" title="interface in twitter4j"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  317. </ul>
  318. <ul class="navList">
  319. <li><a href="../index.html?twitter4j/URLEntity.html" target="_top">Frames</a></li>
  320. <li><a href="URLEntity.html" target="_top">No&nbsp;Frames</a></li>
  321. </ul>
  322. <ul class="navList" id="allclasses_navbar_bottom">
  323. <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
  324. </ul>
  325. <div>
  326. <script type="text/javascript"><!--
  327. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  328. if(window==top) {
  329. allClassesLink.style.display = "block";
  330. }
  331. else {
  332. allClassesLink.style.display = "none";
  333. }
  334. //-->
  335. </script>
  336. </div>
  337. <div>
  338. <ul class="subNavList">
  339. <li>Summary:&nbsp;</li>
  340. <li>Nested&nbsp;|&nbsp;</li>
  341. <li>Field&nbsp;|&nbsp;</li>
  342. <li>Constr&nbsp;|&nbsp;</li>
  343. <li><a href="#method.summary">Method</a></li>
  344. </ul>
  345. <ul class="subNavList">
  346. <li>Detail:&nbsp;</li>
  347. <li>Field&nbsp;|&nbsp;</li>
  348. <li>Constr&nbsp;|&nbsp;</li>
  349. <li><a href="#method.detail">Method</a></li>
  350. </ul>
  351. </div>
  352. <a name="skip.navbar.bottom">
  353. <!-- -->
  354. </a></div>
  355. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  356. <p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
  357. </body>
  358. </html>