UserMentionEntity.html 13 KB

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