Cleanup of some doclint warnings in java.lang (original) (raw)

population count · Mon Jun 17 03:48:02 UTC 2013

* @param value the value to hash
* @return a hash code value for a {@code boolean} value.
 * @since 1.8
*
* @return a hash code value for a {@code boolean} value.
 */
public static int hashCode(boolean value) {
    return value ? 1231 : 1237;
* @param value the value to hash
* @return a hash code value for a {@code byte} value.
 * @since 1.8
*
* @return a hash code value for a {@code byte} value.
 */
public static int hashCode(byte value) {
    return (int)value;
* @param <U> the type to cast this class object to
* @param clazz the class of the type to cast this class object to
 * @return this {@code Class} object, cast to represent a subclass of
 *    the specified class object.
 * @throws ClassCastException if this {@code Class} object does not
* @return an object representing the superclass
 * @since 1.8
 */
public AnnotatedType getAnnotatedSuperclass() {
* @return an array representing the superinterfaces
 * @since 1.8
 */
public AnnotatedType[] getAnnotatedInterfaces() {
* <code>
 * <pre>
 *  final String Digits     = "(\\p{Digit}+)";
 *  final String HexDigits  = "(\\p{XDigit}+)";
* </code>
 *
 * @param      s   the string to be parsed.
 * @return     a {@code Double} object holding the value
* @param value the value to hash
* @return a hash code value for a {@code double} value.
 * @since 1.8
*
* @return a hash code value for a {@code double} value.
 */
public static int hashCode(double value) {
    long bits = doubleToLongBits(value);
* @param value the value to hash
* @return a hash code value for a {@code float} value.
 * @since 1.8
*
* @return a hash code value for a {@code float} value.
 */
public static int hashCode(float value) {
    return floatToIntBits(value);
* @param value the value to hash
 * @since 1.8
 *
 * @return a hash code value for a {@code int} value.
* @param i the value whose highest one bit is to be computed
 * @return an {@code int} value with a single one-bit, in the position
 *     of the highest-order one-bit in the specified value, or zero if
 *     the specified value is itself equal to zero.
* @param i the value whose lowest one bit is to be computed
 * @return an {@code int} value with a single one-bit, in the position
 *     of the lowest-order one-bit in the specified value, or zero if
 *     the specified value is itself equal to zero.
* @param i the value whose number of leading zeros is to be computed
 * @return the number of zero bits preceding the highest-order
 *     ("leftmost") one-bit in the two's complement binary
* @param i the value whose number of trailing zeros is to be computed
 * @return the number of zero bits following the lowest-order
* @param i the value whose bits are to be counted
 * @return the number of one-bits in the two's complement binary
 *     representation of the specified {@code int} value.
 * @since 1.5
* @param i the value whose bits are to be rotated left
* @param distance the number of bit positions to rotate left
 * @return the value obtained by rotating the two's complement binary
 *     representation of the specified {@code int} value left by the
 *     specified number of bits.
* @param i the value whose bits are to be rotated right
* @param distance the number of bit positions to rotate right
 * @return the value obtained by rotating the two's complement binary
 *     representation of the specified {@code int} value right by the
 *     specified number of bits.
* @param i the value to be reversed
 * @return the value obtained by reversing order of the bits in the
 *     specified {@code int} value.
 * @since 1.5
* @param i the value whose signum is to be computed
 * @return the signum function of the specified {@code int} value.
 * @since 1.5
 */
* @param i the value whose bytes are to be reversed
 * @return the value obtained by reversing the bytes in the specified
 *     {@code int} value.
 * @since 1.5
* @param value the value to hash
* @return a hash code value for a {@code long} value.
 * @since 1.8
*
* @return a hash code value for a {@code long} value.
 */
public static int hashCode(long value) {
    return (int)(value ^ (value >>> 32));
* @param i the value whose highest one bit is to be computed
 * @return a {@code long} value with a single one-bit, in the position
 *     of the highest-order one-bit in the specified value, or zero if
 *     the specified value is itself equal to zero.
* @param i the value whose lowest one bit is to be computed
 * @return a {@code long} value with a single one-bit, in the position
 *     of the lowest-order one-bit in the specified value, or zero if
 *     the specified value is itself equal to zero.
* @param i the value whose number of leading zeros is to be computed
 * @return the number of zero bits preceding the highest-order
 *     ("leftmost") one-bit in the two's complement binary
* @param i the value whose number of trailing zeros is to be computed
 * @return the number of zero bits following the lowest-order
* @param i the value whose bits are to be counted
 * @return the number of one-bits in the two's complement binary
 *     representation of the specified {@code long} value.
 * @since 1.5
* @param i the value whose bits are to be rotated left
* @param distance the number of bit positions to rotate left
 * @return the value obtained by rotating the two's complement binary
 *     representation of the specified {@code long} value left by the
 *     specified number of bits.
* @param i the value whose bits are to be rotated right
* @param distance the number of bit positions to rotate right
 * @return the value obtained by rotating the two's complement binary
 *     representation of the specified {@code long} value right by the
 *     specified number of bits.
* @param i the value to be reversed
 * @return the value obtained by reversing order of the bits in the
 *     specified {@code long} value.
 * @since 1.5
* @param i the value whose signum is to be computed
 * @return the signum function of the specified {@code long} value.
 * @since 1.5
 */
* @param i the value whose bytes are to be reversed
 * @return the value obtained by reversing the bytes in the specified
 *     {@code long} value.
 * @since 1.5
*   <p> <li> The program <i>exits</i> normally, when the last
*   <li> The program <i>exits</i> normally, when the last non-daemon
 *   thread exits or when the <tt>{@link #exit exit}</tt>
*   <tt>{@link System#exit(int) System.exit}</tt>) method is
*   {<tt>{@link System#exit(int) System.exit}</tt>) method is
*   <p> <li> The virtual machine is <i>terminated</i> in response to a
*   <li> The virtual machine is <i>terminated</i> in response to a
 *   user interrupt, such as typing <tt>^C</tt>, or a system-wide
* @param value the value to hash
 * @return a hash code value for a {@code short} value.
 */
public static int hashCode(short value) {
* @param i the value whose bytes are to be reversed
 * @return the value obtained by reversing (or, equivalently,
* @return the unbiased exponent of the argument
 * @since 1.6
 */
public static int getExponent(float f) {
* @return the unbiased exponent of the argument
 * @since 1.6
 */
public static int getExponent(double d) {
* @return the set of warnings to be suppressed
 */
String[] value();
*
* @return the system-dependent line separator string
 * @since 1.7
 */
public static String lineSeparator() {
* @return the annotation type of this annotation
 */
Class<? extends Annotation> annotationType();