Long.hx 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830
  1. package java.lang;
  2. /*
  3. * Copyright (c) 1994, 2009, Oracle and/or its affiliates. All rights reserved.
  4. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  5. *
  6. * This code is free software; you can redistribute it and/or modify it
  7. * under the terms of the GNU General Public License version 2 only, as
  8. * published by the Free Software Foundation. Oracle designates this
  9. * particular file as subject to the "Classpath" exception as provided
  10. * by Oracle in the LICENSE file that accompanied this code.
  11. *
  12. * This code is distributed in the hope that it will be useful, but WITHOUT
  13. * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14. * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  15. * version 2 for more details (a copy is included in the LICENSE file that
  16. * accompanied this code).
  17. *
  18. * You should have received a copy of the GNU General Public License version
  19. * 2 along with this work; if not, write to the Free Software Foundation,
  20. * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  21. *
  22. * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  23. * or visit www.oracle.com if you need additional information or have any
  24. * questions.
  25. */
  26. /**
  27. * The {@code Long} class wraps a value of the primitive type {@code
  28. * long} in an object. An object of type {@code Long} contains a
  29. * single field whose type is {@code long}.
  30. *
  31. * <p> In addition, this class provides several methods for converting
  32. * a {@code long} to a {@code String} and a {@code String} to a {@code
  33. * long}, as well as other constants and methods useful when dealing
  34. * with a {@code long}.
  35. *
  36. * <p>Implementation note: The implementations of the "bit twiddling"
  37. * methods (such as {@link #highestOneBit(long) highestOneBit} and
  38. * {@link #numberOfTrailingZeros(long) numberOfTrailingZeros}) are
  39. * based on material from Henry S. Warren, Jr.'s <i>Hacker's
  40. * Delight</i>, (Addison Wesley, 2002).
  41. *
  42. * @author Lee Boynton
  43. * @author Arthur van Hoff
  44. * @author Josh Bloch
  45. * @author Joseph D. Darcy
  46. * @since JDK1.0
  47. */
  48. @:require(java0) extern class Long extends java.lang.Number implements java.lang.Comparable<Long>
  49. {
  50. /**
  51. * A constant holding the minimum value a {@code long} can
  52. * have, -2<sup>63</sup>.
  53. */
  54. public static var MIN_VALUE(default, null) : haxe.Int64;
  55. /**
  56. * A constant holding the maximum value a {@code long} can
  57. * have, 2<sup>63</sup>-1.
  58. */
  59. public static var MAX_VALUE(default, null) : haxe.Int64;
  60. /**
  61. * The {@code Class} instance representing the primitive type
  62. * {@code long}.
  63. *
  64. * @since JDK1.1
  65. */
  66. @:require(java1) public static var TYPE(default, null) : Class<Long>;
  67. /**
  68. * Returns a string representation of the first argument in the
  69. * radix specified by the second argument.
  70. *
  71. * <p>If the radix is smaller than {@code Character.MIN_RADIX}
  72. * or larger than {@code Character.MAX_RADIX}, then the radix
  73. * {@code 10} is used instead.
  74. *
  75. * <p>If the first argument is negative, the first element of the
  76. * result is the ASCII minus sign {@code '-'}
  77. * (<code>'&#92;u002d'</code>). If the first argument is not
  78. * negative, no sign character appears in the result.
  79. *
  80. * <p>The remaining characters of the result represent the magnitude
  81. * of the first argument. If the magnitude is zero, it is
  82. * represented by a single zero character {@code '0'}
  83. * (<code>'&#92;u0030'</code>); otherwise, the first character of
  84. * the representation of the magnitude will not be the zero
  85. * character. The following ASCII characters are used as digits:
  86. *
  87. * <blockquote>
  88. * {@code 0123456789abcdefghijklmnopqrstuvwxyz}
  89. * </blockquote>
  90. *
  91. * These are <code>'&#92;u0030'</code> through
  92. * <code>'&#92;u0039'</code> and <code>'&#92;u0061'</code> through
  93. * <code>'&#92;u007a'</code>. If {@code radix} is
  94. * <var>N</var>, then the first <var>N</var> of these characters
  95. * are used as radix-<var>N</var> digits in the order shown. Thus,
  96. * the digits for hexadecimal (radix 16) are
  97. * {@code 0123456789abcdef}. If uppercase letters are
  98. * desired, the {@link java.lang.String#toUpperCase()} method may
  99. * be called on the result:
  100. *
  101. * <blockquote>
  102. * {@code Long.toString(n, 16).toUpperCase()}
  103. * </blockquote>
  104. *
  105. * @param i a {@code long} to be converted to a string.
  106. * @param radix the radix to use in the string representation.
  107. * @return a string representation of the argument in the specified radix.
  108. * @see java.lang.Character#MAX_RADIX
  109. * @see java.lang.Character#MIN_RADIX
  110. */
  111. @:native('toString') @:overload public static function _toString(i : haxe.Int64, radix : Int) : String;
  112. /**
  113. * Returns a string representation of the {@code long}
  114. * argument as an unsigned integer in base&nbsp;16.
  115. *
  116. * <p>The unsigned {@code long} value is the argument plus
  117. * 2<sup>64</sup> if the argument is negative; otherwise, it is
  118. * equal to the argument. This value is converted to a string of
  119. * ASCII digits in hexadecimal (base&nbsp;16) with no extra
  120. * leading {@code 0}s. If the unsigned magnitude is zero, it
  121. * is represented by a single zero character {@code '0'}
  122. * (<code>'&#92;u0030'</code>); otherwise, the first character of
  123. * the representation of the unsigned magnitude will not be the
  124. * zero character. The following characters are used as
  125. * hexadecimal digits:
  126. *
  127. * <blockquote>
  128. * {@code 0123456789abcdef}
  129. * </blockquote>
  130. *
  131. * These are the characters <code>'&#92;u0030'</code> through
  132. * <code>'&#92;u0039'</code> and <code>'&#92;u0061'</code> through
  133. * <code>'&#92;u0066'</code>. If uppercase letters are desired,
  134. * the {@link java.lang.String#toUpperCase()} method may be called
  135. * on the result:
  136. *
  137. * <blockquote>
  138. * {@code Long.toHexString(n).toUpperCase()}
  139. * </blockquote>
  140. *
  141. * @param i a {@code long} to be converted to a string.
  142. * @return the string representation of the unsigned {@code long}
  143. * value represented by the argument in hexadecimal
  144. * (base&nbsp;16).
  145. * @since JDK 1.0.2
  146. */
  147. @:require(java0) @:overload public static function toHexString(i : haxe.Int64) : String;
  148. /**
  149. * Returns a string representation of the {@code long}
  150. * argument as an unsigned integer in base&nbsp;8.
  151. *
  152. * <p>The unsigned {@code long} value is the argument plus
  153. * 2<sup>64</sup> if the argument is negative; otherwise, it is
  154. * equal to the argument. This value is converted to a string of
  155. * ASCII digits in octal (base&nbsp;8) with no extra leading
  156. * {@code 0}s.
  157. *
  158. * <p>If the unsigned magnitude is zero, it is represented by a
  159. * single zero character {@code '0'}
  160. * (<code>'&#92;u0030'</code>); otherwise, the first character of
  161. * the representation of the unsigned magnitude will not be the
  162. * zero character. The following characters are used as octal
  163. * digits:
  164. *
  165. * <blockquote>
  166. * {@code 01234567}
  167. * </blockquote>
  168. *
  169. * These are the characters <code>'&#92;u0030'</code> through
  170. * <code>'&#92;u0037'</code>.
  171. *
  172. * @param i a {@code long} to be converted to a string.
  173. * @return the string representation of the unsigned {@code long}
  174. * value represented by the argument in octal (base&nbsp;8).
  175. * @since JDK 1.0.2
  176. */
  177. @:require(java0) @:overload public static function toOctalString(i : haxe.Int64) : String;
  178. /**
  179. * Returns a string representation of the {@code long}
  180. * argument as an unsigned integer in base&nbsp;2.
  181. *
  182. * <p>The unsigned {@code long} value is the argument plus
  183. * 2<sup>64</sup> if the argument is negative; otherwise, it is
  184. * equal to the argument. This value is converted to a string of
  185. * ASCII digits in binary (base&nbsp;2) with no extra leading
  186. * {@code 0}s. If the unsigned magnitude is zero, it is
  187. * represented by a single zero character {@code '0'}
  188. * (<code>'&#92;u0030'</code>); otherwise, the first character of
  189. * the representation of the unsigned magnitude will not be the
  190. * zero character. The characters {@code '0'}
  191. * (<code>'&#92;u0030'</code>) and {@code '1'}
  192. * (<code>'&#92;u0031'</code>) are used as binary digits.
  193. *
  194. * @param i a {@code long} to be converted to a string.
  195. * @return the string representation of the unsigned {@code long}
  196. * value represented by the argument in binary (base&nbsp;2).
  197. * @since JDK 1.0.2
  198. */
  199. @:require(java0) @:overload public static function toBinaryString(i : haxe.Int64) : String;
  200. /**
  201. * Returns a {@code String} object representing the specified
  202. * {@code long}. The argument is converted to signed decimal
  203. * representation and returned as a string, exactly as if the
  204. * argument and the radix 10 were given as arguments to the {@link
  205. * #toString(long, int)} method.
  206. *
  207. * @param i a {@code long} to be converted.
  208. * @return a string representation of the argument in base&nbsp;10.
  209. */
  210. @:native('toString') @:overload public static function _toString(i : haxe.Int64) : String;
  211. /**
  212. * Parses the string argument as a signed {@code long} in the
  213. * radix specified by the second argument. The characters in the
  214. * string must all be digits of the specified radix (as determined
  215. * by whether {@link java.lang.Character#digit(char, int)} returns
  216. * a nonnegative value), except that the first character may be an
  217. * ASCII minus sign {@code '-'} (<code>'&#92;u002D'</code>) to
  218. * indicate a negative value or an ASCII plus sign {@code '+'}
  219. * (<code>'&#92;u002B'</code>) to indicate a positive value. The
  220. * resulting {@code long} value is returned.
  221. *
  222. * <p>Note that neither the character {@code L}
  223. * (<code>'&#92;u004C'</code>) nor {@code l}
  224. * (<code>'&#92;u006C'</code>) is permitted to appear at the end
  225. * of the string as a type indicator, as would be permitted in
  226. * Java programming language source code - except that either
  227. * {@code L} or {@code l} may appear as a digit for a
  228. * radix greater than 22.
  229. *
  230. * <p>An exception of type {@code NumberFormatException} is
  231. * thrown if any of the following situations occurs:
  232. * <ul>
  233. *
  234. * <li>The first argument is {@code null} or is a string of
  235. * length zero.
  236. *
  237. * <li>The {@code radix} is either smaller than {@link
  238. * java.lang.Character#MIN_RADIX} or larger than {@link
  239. * java.lang.Character#MAX_RADIX}.
  240. *
  241. * <li>Any character of the string is not a digit of the specified
  242. * radix, except that the first character may be a minus sign
  243. * {@code '-'} (<code>'&#92;u002d'</code>) or plus sign {@code
  244. * '+'} (<code>'&#92;u002B'</code>) provided that the string is
  245. * longer than length 1.
  246. *
  247. * <li>The value represented by the string is not a value of type
  248. * {@code long}.
  249. * </ul>
  250. *
  251. * <p>Examples:
  252. * <blockquote><pre>
  253. * parseLong("0", 10) returns 0L
  254. * parseLong("473", 10) returns 473L
  255. * parseLong("+42", 10) returns 42L
  256. * parseLong("-0", 10) returns 0L
  257. * parseLong("-FF", 16) returns -255L
  258. * parseLong("1100110", 2) returns 102L
  259. * parseLong("99", 8) throws a NumberFormatException
  260. * parseLong("Hazelnut", 10) throws a NumberFormatException
  261. * parseLong("Hazelnut", 36) returns 1356099454469L
  262. * </pre></blockquote>
  263. *
  264. * @param s the {@code String} containing the
  265. * {@code long} representation to be parsed.
  266. * @param radix the radix to be used while parsing {@code s}.
  267. * @return the {@code long} represented by the string argument in
  268. * the specified radix.
  269. * @throws NumberFormatException if the string does not contain a
  270. * parsable {@code long}.
  271. */
  272. @:overload public static function parseLong(s : String, radix : Int) : haxe.Int64;
  273. /**
  274. * Parses the string argument as a signed decimal {@code long}.
  275. * The characters in the string must all be decimal digits, except
  276. * that the first character may be an ASCII minus sign {@code '-'}
  277. * (<code>&#92;u002D'</code>) to indicate a negative value or an
  278. * ASCII plus sign {@code '+'} (<code>'&#92;u002B'</code>) to
  279. * indicate a positive value. The resulting {@code long} value is
  280. * returned, exactly as if the argument and the radix {@code 10}
  281. * were given as arguments to the {@link
  282. * #parseLong(java.lang.String, int)} method.
  283. *
  284. * <p>Note that neither the character {@code L}
  285. * (<code>'&#92;u004C'</code>) nor {@code l}
  286. * (<code>'&#92;u006C'</code>) is permitted to appear at the end
  287. * of the string as a type indicator, as would be permitted in
  288. * Java programming language source code.
  289. *
  290. * @param s a {@code String} containing the {@code long}
  291. * representation to be parsed
  292. * @return the {@code long} represented by the argument in
  293. * decimal.
  294. * @throws NumberFormatException if the string does not contain a
  295. * parsable {@code long}.
  296. */
  297. @:overload public static function parseLong(s : String) : haxe.Int64;
  298. /**
  299. * Returns a {@code Long} object holding the value
  300. * extracted from the specified {@code String} when parsed
  301. * with the radix given by the second argument. The first
  302. * argument is interpreted as representing a signed
  303. * {@code long} in the radix specified by the second
  304. * argument, exactly as if the arguments were given to the {@link
  305. * #parseLong(java.lang.String, int)} method. The result is a
  306. * {@code Long} object that represents the {@code long}
  307. * value specified by the string.
  308. *
  309. * <p>In other words, this method returns a {@code Long} object equal
  310. * to the value of:
  311. *
  312. * <blockquote>
  313. * {@code new Long(Long.parseLong(s, radix))}
  314. * </blockquote>
  315. *
  316. * @param s the string to be parsed
  317. * @param radix the radix to be used in interpreting {@code s}
  318. * @return a {@code Long} object holding the value
  319. * represented by the string argument in the specified
  320. * radix.
  321. * @throws NumberFormatException If the {@code String} does not
  322. * contain a parsable {@code long}.
  323. */
  324. @:overload public static function valueOf(s : String, radix : Int) : Long;
  325. /**
  326. * Returns a {@code Long} object holding the value
  327. * of the specified {@code String}. The argument is
  328. * interpreted as representing a signed decimal {@code long},
  329. * exactly as if the argument were given to the {@link
  330. * #parseLong(java.lang.String)} method. The result is a
  331. * {@code Long} object that represents the integer value
  332. * specified by the string.
  333. *
  334. * <p>In other words, this method returns a {@code Long} object
  335. * equal to the value of:
  336. *
  337. * <blockquote>
  338. * {@code new Long(Long.parseLong(s))}
  339. * </blockquote>
  340. *
  341. * @param s the string to be parsed.
  342. * @return a {@code Long} object holding the value
  343. * represented by the string argument.
  344. * @throws NumberFormatException If the string cannot be parsed
  345. * as a {@code long}.
  346. */
  347. @:overload public static function valueOf(s : String) : Long;
  348. /**
  349. * Returns a {@code Long} instance representing the specified
  350. * {@code long} value.
  351. * If a new {@code Long} instance is not required, this method
  352. * should generally be used in preference to the constructor
  353. * {@link #Long(long)}, as this method is likely to yield
  354. * significantly better space and time performance by caching
  355. * frequently requested values.
  356. *
  357. * Note that unlike the {@linkplain Integer#valueOf(int)
  358. * corresponding method} in the {@code Integer} class, this method
  359. * is <em>not</em> required to cache values within a particular
  360. * range.
  361. *
  362. * @param l a long value.
  363. * @return a {@code Long} instance representing {@code l}.
  364. * @since 1.5
  365. */
  366. @:require(java5) @:overload public static function valueOf(l : haxe.Int64) : Long;
  367. /**
  368. * Decodes a {@code String} into a {@code Long}.
  369. * Accepts decimal, hexadecimal, and octal numbers given by the
  370. * following grammar:
  371. *
  372. * <blockquote>
  373. * <dl>
  374. * <dt><i>DecodableString:</i>
  375. * <dd><i>Sign<sub>opt</sub> DecimalNumeral</i>
  376. * <dd><i>Sign<sub>opt</sub></i> {@code 0x} <i>HexDigits</i>
  377. * <dd><i>Sign<sub>opt</sub></i> {@code 0X} <i>HexDigits</i>
  378. * <dd><i>Sign<sub>opt</sub></i> {@code #} <i>HexDigits</i>
  379. * <dd><i>Sign<sub>opt</sub></i> {@code 0} <i>OctalDigits</i>
  380. * <p>
  381. * <dt><i>Sign:</i>
  382. * <dd>{@code -}
  383. * <dd>{@code +}
  384. * </dl>
  385. * </blockquote>
  386. *
  387. * <i>DecimalNumeral</i>, <i>HexDigits</i>, and <i>OctalDigits</i>
  388. * are as defined in section 3.10.1 of
  389. * <cite>The Java&trade; Language Specification</cite>,
  390. * except that underscores are not accepted between digits.
  391. *
  392. * <p>The sequence of characters following an optional
  393. * sign and/or radix specifier ("{@code 0x}", "{@code 0X}",
  394. * "{@code #}", or leading zero) is parsed as by the {@code
  395. * Long.parseLong} method with the indicated radix (10, 16, or 8).
  396. * This sequence of characters must represent a positive value or
  397. * a {@link NumberFormatException} will be thrown. The result is
  398. * negated if first character of the specified {@code String} is
  399. * the minus sign. No whitespace characters are permitted in the
  400. * {@code String}.
  401. *
  402. * @param nm the {@code String} to decode.
  403. * @return a {@code Long} object holding the {@code long}
  404. * value represented by {@code nm}
  405. * @throws NumberFormatException if the {@code String} does not
  406. * contain a parsable {@code long}.
  407. * @see java.lang.Long#parseLong(String, int)
  408. * @since 1.2
  409. */
  410. @:require(java2) @:overload public static function decode(nm : String) : Long;
  411. /**
  412. * Constructs a newly allocated {@code Long} object that
  413. * represents the specified {@code long} argument.
  414. *
  415. * @param value the value to be represented by the
  416. * {@code Long} object.
  417. */
  418. @:overload public function new(value : haxe.Int64) : Void;
  419. /**
  420. * Constructs a newly allocated {@code Long} object that
  421. * represents the {@code long} value indicated by the
  422. * {@code String} parameter. The string is converted to a
  423. * {@code long} value in exactly the manner used by the
  424. * {@code parseLong} method for radix 10.
  425. *
  426. * @param s the {@code String} to be converted to a
  427. * {@code Long}.
  428. * @throws NumberFormatException if the {@code String} does not
  429. * contain a parsable {@code long}.
  430. * @see java.lang.Long#parseLong(java.lang.String, int)
  431. */
  432. @:overload public function new(s : String) : Void;
  433. /**
  434. * Returns the value of this {@code Long} as a
  435. * {@code byte}.
  436. */
  437. @:overload override public function byteValue() : java.StdTypes.Int8;
  438. /**
  439. * Returns the value of this {@code Long} as a
  440. * {@code short}.
  441. */
  442. @:overload override public function shortValue() : java.StdTypes.Int16;
  443. /**
  444. * Returns the value of this {@code Long} as an
  445. * {@code int}.
  446. */
  447. @:overload override public function intValue() : Int;
  448. /**
  449. * Returns the value of this {@code Long} as a
  450. * {@code long} value.
  451. */
  452. @:overload override public function longValue() : haxe.Int64;
  453. /**
  454. * Returns the value of this {@code Long} as a
  455. * {@code float}.
  456. */
  457. @:overload override public function floatValue() : Single;
  458. /**
  459. * Returns the value of this {@code Long} as a
  460. * {@code double}.
  461. */
  462. @:overload override public function doubleValue() : Float;
  463. /**
  464. * Returns a {@code String} object representing this
  465. * {@code Long}'s value. The value is converted to signed
  466. * decimal representation and returned as a string, exactly as if
  467. * the {@code long} value were given as an argument to the
  468. * {@link java.lang.Long#toString(long)} method.
  469. *
  470. * @return a string representation of the value of this object in
  471. * base&nbsp;10.
  472. */
  473. @:overload public function toString() : String;
  474. /**
  475. * Returns a hash code for this {@code Long}. The result is
  476. * the exclusive OR of the two halves of the primitive
  477. * {@code long} value held by this {@code Long}
  478. * object. That is, the hashcode is the value of the expression:
  479. *
  480. * <blockquote>
  481. * {@code (int)(this.longValue()^(this.longValue()>>>32))}
  482. * </blockquote>
  483. *
  484. * @return a hash code value for this object.
  485. */
  486. @:overload public function hashCode() : Int;
  487. /**
  488. * Compares this object to the specified object. The result is
  489. * {@code true} if and only if the argument is not
  490. * {@code null} and is a {@code Long} object that
  491. * contains the same {@code long} value as this object.
  492. *
  493. * @param obj the object to compare with.
  494. * @return {@code true} if the objects are the same;
  495. * {@code false} otherwise.
  496. */
  497. @:overload public function equals(obj : Dynamic) : Bool;
  498. /**
  499. * Determines the {@code long} value of the system property
  500. * with the specified name.
  501. *
  502. * <p>The first argument is treated as the name of a system property.
  503. * System properties are accessible through the {@link
  504. * java.lang.System#getProperty(java.lang.String)} method. The
  505. * string value of this property is then interpreted as a
  506. * {@code long} value and a {@code Long} object
  507. * representing this value is returned. Details of possible
  508. * numeric formats can be found with the definition of
  509. * {@code getProperty}.
  510. *
  511. * <p>If there is no property with the specified name, if the
  512. * specified name is empty or {@code null}, or if the
  513. * property does not have the correct numeric format, then
  514. * {@code null} is returned.
  515. *
  516. * <p>In other words, this method returns a {@code Long} object equal to
  517. * the value of:
  518. *
  519. * <blockquote>
  520. * {@code getLong(nm, null)}
  521. * </blockquote>
  522. *
  523. * @param nm property name.
  524. * @return the {@code Long} value of the property.
  525. * @see java.lang.System#getProperty(java.lang.String)
  526. * @see java.lang.System#getProperty(java.lang.String, java.lang.String)
  527. */
  528. @:overload public static function getLong(nm : String) : Long;
  529. /**
  530. * Determines the {@code long} value of the system property
  531. * with the specified name.
  532. *
  533. * <p>The first argument is treated as the name of a system property.
  534. * System properties are accessible through the {@link
  535. * java.lang.System#getProperty(java.lang.String)} method. The
  536. * string value of this property is then interpreted as a
  537. * {@code long} value and a {@code Long} object
  538. * representing this value is returned. Details of possible
  539. * numeric formats can be found with the definition of
  540. * {@code getProperty}.
  541. *
  542. * <p>The second argument is the default value. A {@code Long} object
  543. * that represents the value of the second argument is returned if there
  544. * is no property of the specified name, if the property does not have
  545. * the correct numeric format, or if the specified name is empty or null.
  546. *
  547. * <p>In other words, this method returns a {@code Long} object equal
  548. * to the value of:
  549. *
  550. * <blockquote>
  551. * {@code getLong(nm, new Long(val))}
  552. * </blockquote>
  553. *
  554. * but in practice it may be implemented in a manner such as:
  555. *
  556. * <blockquote><pre>
  557. * Long result = getLong(nm, null);
  558. * return (result == null) ? new Long(val) : result;
  559. * </pre></blockquote>
  560. *
  561. * to avoid the unnecessary allocation of a {@code Long} object when
  562. * the default value is not needed.
  563. *
  564. * @param nm property name.
  565. * @param val default value.
  566. * @return the {@code Long} value of the property.
  567. * @see java.lang.System#getProperty(java.lang.String)
  568. * @see java.lang.System#getProperty(java.lang.String, java.lang.String)
  569. */
  570. @:overload public static function getLong(nm : String, val : haxe.Int64) : Long;
  571. /**
  572. * Returns the {@code long} value of the system property with
  573. * the specified name. The first argument is treated as the name
  574. * of a system property. System properties are accessible through
  575. * the {@link java.lang.System#getProperty(java.lang.String)}
  576. * method. The string value of this property is then interpreted
  577. * as a {@code long} value, as per the
  578. * {@code Long.decode} method, and a {@code Long} object
  579. * representing this value is returned.
  580. *
  581. * <ul>
  582. * <li>If the property value begins with the two ASCII characters
  583. * {@code 0x} or the ASCII character {@code #}, not followed by
  584. * a minus sign, then the rest of it is parsed as a hexadecimal integer
  585. * exactly as for the method {@link #valueOf(java.lang.String, int)}
  586. * with radix 16.
  587. * <li>If the property value begins with the ASCII character
  588. * {@code 0} followed by another character, it is parsed as
  589. * an octal integer exactly as by the method {@link
  590. * #valueOf(java.lang.String, int)} with radix 8.
  591. * <li>Otherwise the property value is parsed as a decimal
  592. * integer exactly as by the method
  593. * {@link #valueOf(java.lang.String, int)} with radix 10.
  594. * </ul>
  595. *
  596. * <p>Note that, in every case, neither {@code L}
  597. * (<code>'&#92;u004C'</code>) nor {@code l}
  598. * (<code>'&#92;u006C'</code>) is permitted to appear at the end
  599. * of the property value as a type indicator, as would be
  600. * permitted in Java programming language source code.
  601. *
  602. * <p>The second argument is the default value. The default value is
  603. * returned if there is no property of the specified name, if the
  604. * property does not have the correct numeric format, or if the
  605. * specified name is empty or {@code null}.
  606. *
  607. * @param nm property name.
  608. * @param val default value.
  609. * @return the {@code Long} value of the property.
  610. * @see java.lang.System#getProperty(java.lang.String)
  611. * @see java.lang.System#getProperty(java.lang.String, java.lang.String)
  612. * @see java.lang.Long#decode
  613. */
  614. @:overload public static function getLong(nm : String, val : Long) : Long;
  615. /**
  616. * Compares two {@code Long} objects numerically.
  617. *
  618. * @param anotherLong the {@code Long} to be compared.
  619. * @return the value {@code 0} if this {@code Long} is
  620. * equal to the argument {@code Long}; a value less than
  621. * {@code 0} if this {@code Long} is numerically less
  622. * than the argument {@code Long}; and a value greater
  623. * than {@code 0} if this {@code Long} is numerically
  624. * greater than the argument {@code Long} (signed
  625. * comparison).
  626. * @since 1.2
  627. */
  628. @:require(java2) @:overload public function compareTo(anotherLong : Long) : Int;
  629. /**
  630. * Compares two {@code long} values numerically.
  631. * The value returned is identical to what would be returned by:
  632. * <pre>
  633. * Long.valueOf(x).compareTo(Long.valueOf(y))
  634. * </pre>
  635. *
  636. * @param x the first {@code long} to compare
  637. * @param y the second {@code long} to compare
  638. * @return the value {@code 0} if {@code x == y};
  639. * a value less than {@code 0} if {@code x < y}; and
  640. * a value greater than {@code 0} if {@code x > y}
  641. * @since 1.7
  642. */
  643. @:require(java7) @:overload public static function compare(x : haxe.Int64, y : haxe.Int64) : Int;
  644. /**
  645. * The number of bits used to represent a {@code long} value in two's
  646. * complement binary form.
  647. *
  648. * @since 1.5
  649. */
  650. @:require(java5) public static var SIZE(default, null) : Int;
  651. /**
  652. * Returns a {@code long} value with at most a single one-bit, in the
  653. * position of the highest-order ("leftmost") one-bit in the specified
  654. * {@code long} value. Returns zero if the specified value has no
  655. * one-bits in its two's complement binary representation, that is, if it
  656. * is equal to zero.
  657. *
  658. * @return a {@code long} value with a single one-bit, in the position
  659. * of the highest-order one-bit in the specified value, or zero if
  660. * the specified value is itself equal to zero.
  661. * @since 1.5
  662. */
  663. @:require(java5) @:overload public static function highestOneBit(i : haxe.Int64) : haxe.Int64;
  664. /**
  665. * Returns a {@code long} value with at most a single one-bit, in the
  666. * position of the lowest-order ("rightmost") one-bit in the specified
  667. * {@code long} value. Returns zero if the specified value has no
  668. * one-bits in its two's complement binary representation, that is, if it
  669. * is equal to zero.
  670. *
  671. * @return a {@code long} value with a single one-bit, in the position
  672. * of the lowest-order one-bit in the specified value, or zero if
  673. * the specified value is itself equal to zero.
  674. * @since 1.5
  675. */
  676. @:require(java5) @:overload public static function lowestOneBit(i : haxe.Int64) : haxe.Int64;
  677. /**
  678. * Returns the number of zero bits preceding the highest-order
  679. * ("leftmost") one-bit in the two's complement binary representation
  680. * of the specified {@code long} value. Returns 64 if the
  681. * specified value has no one-bits in its two's complement representation,
  682. * in other words if it is equal to zero.
  683. *
  684. * <p>Note that this method is closely related to the logarithm base 2.
  685. * For all positive {@code long} values x:
  686. * <ul>
  687. * <li>floor(log<sub>2</sub>(x)) = {@code 63 - numberOfLeadingZeros(x)}
  688. * <li>ceil(log<sub>2</sub>(x)) = {@code 64 - numberOfLeadingZeros(x - 1)}
  689. * </ul>
  690. *
  691. * @return the number of zero bits preceding the highest-order
  692. * ("leftmost") one-bit in the two's complement binary representation
  693. * of the specified {@code long} value, or 64 if the value
  694. * is equal to zero.
  695. * @since 1.5
  696. */
  697. @:require(java5) @:overload public static function numberOfLeadingZeros(i : haxe.Int64) : Int;
  698. /**
  699. * Returns the number of zero bits following the lowest-order ("rightmost")
  700. * one-bit in the two's complement binary representation of the specified
  701. * {@code long} value. Returns 64 if the specified value has no
  702. * one-bits in its two's complement representation, in other words if it is
  703. * equal to zero.
  704. *
  705. * @return the number of zero bits following the lowest-order ("rightmost")
  706. * one-bit in the two's complement binary representation of the
  707. * specified {@code long} value, or 64 if the value is equal
  708. * to zero.
  709. * @since 1.5
  710. */
  711. @:require(java5) @:overload public static function numberOfTrailingZeros(i : haxe.Int64) : Int;
  712. /**
  713. * Returns the number of one-bits in the two's complement binary
  714. * representation of the specified {@code long} value. This function is
  715. * sometimes referred to as the <i>population count</i>.
  716. *
  717. * @return the number of one-bits in the two's complement binary
  718. * representation of the specified {@code long} value.
  719. * @since 1.5
  720. */
  721. @:require(java5) @:overload public static function bitCount(i : haxe.Int64) : Int;
  722. /**
  723. * Returns the value obtained by rotating the two's complement binary
  724. * representation of the specified {@code long} value left by the
  725. * specified number of bits. (Bits shifted out of the left hand, or
  726. * high-order, side reenter on the right, or low-order.)
  727. *
  728. * <p>Note that left rotation with a negative distance is equivalent to
  729. * right rotation: {@code rotateLeft(val, -distance) == rotateRight(val,
  730. * distance)}. Note also that rotation by any multiple of 64 is a
  731. * no-op, so all but the last six bits of the rotation distance can be
  732. * ignored, even if the distance is negative: {@code rotateLeft(val,
  733. * distance) == rotateLeft(val, distance & 0x3F)}.
  734. *
  735. * @return the value obtained by rotating the two's complement binary
  736. * representation of the specified {@code long} value left by the
  737. * specified number of bits.
  738. * @since 1.5
  739. */
  740. @:require(java5) @:overload public static function rotateLeft(i : haxe.Int64, distance : Int) : haxe.Int64;
  741. /**
  742. * Returns the value obtained by rotating the two's complement binary
  743. * representation of the specified {@code long} value right by the
  744. * specified number of bits. (Bits shifted out of the right hand, or
  745. * low-order, side reenter on the left, or high-order.)
  746. *
  747. * <p>Note that right rotation with a negative distance is equivalent to
  748. * left rotation: {@code rotateRight(val, -distance) == rotateLeft(val,
  749. * distance)}. Note also that rotation by any multiple of 64 is a
  750. * no-op, so all but the last six bits of the rotation distance can be
  751. * ignored, even if the distance is negative: {@code rotateRight(val,
  752. * distance) == rotateRight(val, distance & 0x3F)}.
  753. *
  754. * @return the value obtained by rotating the two's complement binary
  755. * representation of the specified {@code long} value right by the
  756. * specified number of bits.
  757. * @since 1.5
  758. */
  759. @:require(java5) @:overload public static function rotateRight(i : haxe.Int64, distance : Int) : haxe.Int64;
  760. /**
  761. * Returns the value obtained by reversing the order of the bits in the
  762. * two's complement binary representation of the specified {@code long}
  763. * value.
  764. *
  765. * @return the value obtained by reversing order of the bits in the
  766. * specified {@code long} value.
  767. * @since 1.5
  768. */
  769. @:require(java5) @:overload public static function reverse(i : haxe.Int64) : haxe.Int64;
  770. /**
  771. * Returns the signum function of the specified {@code long} value. (The
  772. * return value is -1 if the specified value is negative; 0 if the
  773. * specified value is zero; and 1 if the specified value is positive.)
  774. *
  775. * @return the signum function of the specified {@code long} value.
  776. * @since 1.5
  777. */
  778. @:require(java5) @:overload public static function signum(i : haxe.Int64) : Int;
  779. /**
  780. * Returns the value obtained by reversing the order of the bytes in the
  781. * two's complement representation of the specified {@code long} value.
  782. *
  783. * @return the value obtained by reversing the bytes in the specified
  784. * {@code long} value.
  785. * @since 1.5
  786. */
  787. @:require(java5) @:overload public static function reverseBytes(i : haxe.Int64) : haxe.Int64;
  788. }