/*
 * Copyright (c) Data Geekery GmbH (http://www.datageekery.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.joou;

import java.math.BigInteger;

A utility class for static access to unsigned number functionality.

It essentially contains factory methods for unsigned number wrappers. In future versions, it will also contain some arithmetic methods, handling regular arithmetic and bitwise operations

Author:Lukas Eder
/** * A utility class for static access to unsigned number functionality. * <p> * It essentially contains factory methods for unsigned number wrappers. In * future versions, it will also contain some arithmetic methods, handling * regular arithmetic and bitwise operations * * @author Lukas Eder */
public final class Unsigned {
Create an unsigned byte
Throws:
  • NumberFormatException – If value does not contain a parsable unsigned byte.
See Also:
/** * Create an <code>unsigned byte</code> * * @throws NumberFormatException If <code>value</code> does not contain a * parsable <code>unsigned byte</code>. * @see UByte#valueOf(String) */
public static UByte ubyte(String value) throws NumberFormatException { return value == null ? null : UByte.valueOf(value); }
Create an unsigned byte by masking it with 0xFF i.e. (byte) -1 becomes (ubyte) 255
See Also:
  • valueOf.valueOf(byte)
/** * Create an <code>unsigned byte</code> by masking it with <code>0xFF</code> * i.e. <code>(byte) -1</code> becomes <code>(ubyte) 255</code> * * @see UByte#valueOf(byte) */
public static UByte ubyte(byte value) { return UByte.valueOf(value); }
Create an unsigned byte
Throws:
  • NumberFormatException – If value is not in the range of an unsigned byte
See Also:
/** * Create an <code>unsigned byte</code> * * @throws NumberFormatException If <code>value</code> is not in the range * of an <code>unsigned byte</code> * @see UByte#valueOf(short) */
public static UByte ubyte(short value) throws NumberFormatException { return UByte.valueOf(value); }
Create an unsigned byte
Throws:
  • NumberFormatException – If value is not in the range of an unsigned byte
See Also:
/** * Create an <code>unsigned byte</code> * * @throws NumberFormatException If <code>value</code> is not in the range * of an <code>unsigned byte</code> * @see UByte#valueOf(short) */
public static UByte ubyte(int value) throws NumberFormatException { return UByte.valueOf(value); }
Create an unsigned byte
Throws:
  • NumberFormatException – If value is not in the range of an unsigned byte
See Also:
/** * Create an <code>unsigned byte</code> * * @throws NumberFormatException If <code>value</code> is not in the range * of an <code>unsigned byte</code> * @see UByte#valueOf(short) */
public static UByte ubyte(long value) throws NumberFormatException { return UByte.valueOf(value); }
Create an unsigned short
Throws:
  • NumberFormatException – If value does not contain a parsable unsigned short.
See Also:
/** * Create an <code>unsigned short</code> * * @throws NumberFormatException If <code>value</code> does not contain a * parsable <code>unsigned short</code>. * @see UShort#valueOf(String) */
public static UShort ushort(String value) throws NumberFormatException { return value == null ? null : UShort.valueOf(value); }
Create an unsigned short by masking it with 0xFFFF i.e. (short) -1 becomes (ushort) 65535
See Also:
  • valueOf.valueOf(short)
/** * Create an <code>unsigned short</code> by masking it with * <code>0xFFFF</code> i.e. <code>(short) -1</code> becomes * <code>(ushort) 65535</code> * * @see UShort#valueOf(short) */
public static UShort ushort(short value) { return UShort.valueOf(value); }
Create an unsigned short
Throws:
  • NumberFormatException – If value is not in the range of an unsigned short
See Also:
/** * Create an <code>unsigned short</code> * * @throws NumberFormatException If <code>value</code> is not in the range * of an <code>unsigned short</code> * @see UShort#valueOf(int) */
public static UShort ushort(int value) throws NumberFormatException { return UShort.valueOf(value); }
Create an unsigned int
Throws:
  • NumberFormatException – If value does not contain a parsable unsigned int.
See Also:
/** * Create an <code>unsigned int</code> * * @throws NumberFormatException If <code>value</code> does not contain a * parsable <code>unsigned int</code>. * @see UInteger#valueOf(String) */
public static UInteger uint(String value) throws NumberFormatException { return value == null ? null : UInteger.valueOf(value); }
Create an unsigned int by masking it with 0xFFFFFFFF i.e. (int) -1 becomes (uint) 4294967295
See Also:
  • valueOf.valueOf(int)
/** * Create an <code>unsigned int</code> by masking it with * <code>0xFFFFFFFF</code> i.e. <code>(int) -1</code> becomes * <code>(uint) 4294967295</code> * * @see UInteger#valueOf(int) */
public static UInteger uint(int value) { return UInteger.valueOf(value); }
Create an unsigned int
Throws:
  • NumberFormatException – If value is not in the range of an unsigned int
See Also:
/** * Create an <code>unsigned int</code> * * @throws NumberFormatException If <code>value</code> is not in the range * of an <code>unsigned int</code> * @see UInteger#valueOf(long) */
public static UInteger uint(long value) throws NumberFormatException { return UInteger.valueOf(value); }
Create an unsigned long
Throws:
  • NumberFormatException – If value does not contain a parsable unsigned long.
See Also:
/** * Create an <code>unsigned long</code> * * @throws NumberFormatException If <code>value</code> does not contain a * parsable <code>unsigned long</code>. * @see ULong#valueOf(String) */
public static ULong ulong(String value) throws NumberFormatException { return value == null ? null : ULong.valueOf(value); }
Create an unsigned long by masking it with 0xFFFFFFFFFFFFFFFF i.e. (long) -1 becomes (uint) 18446744073709551615
See Also:
  • valueOf.valueOf(long)
/** * Create an <code>unsigned long</code> by masking it with * <code>0xFFFFFFFFFFFFFFFF</code> i.e. <code>(long) -1</code> becomes * <code>(uint) 18446744073709551615</code> * * @see ULong#valueOf(long) */
public static ULong ulong(long value) { return ULong.valueOf(value); }
Create an unsigned long
Throws:
  • NumberFormatException – If value is not in the range of an unsigned long
See Also:
/** * Create an <code>unsigned long</code> * * @throws NumberFormatException If <code>value</code> is not in the range * of an <code>unsigned long</code> * @see ULong#valueOf(BigInteger) */
public static ULong ulong(BigInteger value) throws NumberFormatException { return ULong.valueOf(value); }
No instances
/** * No instances */
private Unsigned() {} }