summaryrefslogtreecommitdiff
path: root/org/freedesktop/dbus/UInt64.java
blob: 855e1aaa771412da03f3e2dcb21413a80856b7d1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/*
   D-Bus Java Implementation
   Copyright (c) 2005-2006 Matthew Johnson

   This program is free software; you can redistribute it and/or modify it
   under the terms of either the GNU General Public License Version 2 or the
   Academic Free Licence Version 2.1.

   Full licence texts are included in the COPYING file with this program.
*/
package org.freedesktop.dbus;

import static org.freedesktop.dbus.Gettext._;

import java.math.BigInteger;

import java.text.MessageFormat;

/**
 * Class to represent unsigned 64-bit numbers.
 * Warning: Any functions which take or return a <tt>long</tt>
 * are restricted to the range of a signed 64bit number.
 * Use the BigInteger methods if you wish access to the full
 * range.
 */
@SuppressWarnings("serial")
public class UInt64 extends Number implements Comparable<UInt64>
{
   /** Maximum allowed value (when accessed as a long) */
   public static final long MAX_LONG_VALUE = Long.MAX_VALUE;
   /** Maximum allowed value (when accessed as a BigInteger) */
   public static final BigInteger MAX_BIG_VALUE = new BigInteger("18446744073709551615");
   /** Minimum allowed value */
   public static final long MIN_VALUE = 0;
   private BigInteger value;
   private long top;
   private long bottom;
   /** Create a UInt64 from a long.
    * @param value Must be a valid integer within MIN_VALUE&ndash;MAX_VALUE 
    * @throws NumberFormatException if value is not between MIN_VALUE and MAX_VALUE
    */
   public UInt64(long value)
   {
      if (value < MIN_VALUE || value > MAX_LONG_VALUE)
         throw new NumberFormatException(MessageFormat.format(_("{0} is not between {1} and {2}."), new Object[] { value, MIN_VALUE, MAX_LONG_VALUE}));
      this.value = new BigInteger(""+value);
      this.top = this.value.shiftRight(32).and(new BigInteger("4294967295")).longValue();
      this.bottom = this.value.and(new BigInteger("4294967295")).longValue();
   }
   /**
    * Create a UInt64 from two longs.
    * @param top Most significant 4 bytes.
    * @param bottom Least significant 4 bytes.
    */
   public UInt64(long top, long bottom)
   {
      BigInteger a = new BigInteger(""+top);
      a = a.shiftLeft(32);
      a = a.add(new BigInteger(""+bottom));
      if (0 > a.compareTo(BigInteger.ZERO))
         throw new NumberFormatException(MessageFormat.format(_("{0} is not between {1} and {2}."), new Object[] { a, MIN_VALUE, MAX_BIG_VALUE}));
      if (0 < a.compareTo(MAX_BIG_VALUE))
         throw new NumberFormatException(MessageFormat.format(_("{0} is not between {1} and {2}."), new Object[] { a, MIN_VALUE, MAX_BIG_VALUE}));
      this.value = a;
      this.top = top;
      this.bottom = bottom;
   }
   /** Create a UInt64 from a BigInteger
    * @param value Must be a valid BigInteger between MIN_VALUE&ndash;MAX_BIG_VALUE
    * @throws NumberFormatException if value is not an integer between MIN_VALUE and MAX_BIG_VALUE
    */
   public UInt64(BigInteger value)
   {
      if (null == value)
         throw new NumberFormatException(MessageFormat.format(_("{0} is not between {1} and {2}."), new Object[] { value, MIN_VALUE, MAX_BIG_VALUE}));
      if (0 > value.compareTo(BigInteger.ZERO))
         throw new NumberFormatException(MessageFormat.format(_("{0} is not between {1} and {2}."), new Object[] { value, MIN_VALUE, MAX_BIG_VALUE}));
      if (0 < value.compareTo(MAX_BIG_VALUE))
         throw new NumberFormatException(MessageFormat.format(_("{0} is not between {1} and {2}."), new Object[] { value, MIN_VALUE, MAX_BIG_VALUE}));
      this.value = value;
      this.top = this.value.shiftRight(32).and(new BigInteger("4294967295")).longValue();
      this.bottom = this.value.and(new BigInteger("4294967295")).longValue();
   }
   /** Create a UInt64 from a String.
    * @param value Must parse to a valid integer within MIN_VALUE&ndash;MAX_BIG_VALUE 
    * @throws NumberFormatException if value is not an integer between MIN_VALUE and MAX_BIG_VALUE
    */
   public UInt64(String value)
   {
      if (null == value)
         throw new NumberFormatException(MessageFormat.format(_("{0} is not between {1} and {2}."), new Object[] { value, MIN_VALUE, MAX_BIG_VALUE}));
      BigInteger a = new BigInteger(value);
      if (0 > a.compareTo(BigInteger.ZERO))
         throw new NumberFormatException(MessageFormat.format(_("{0} is not between {1} and {2}."), new Object[] { value, MIN_VALUE, MAX_BIG_VALUE}));
      if (0 < a.compareTo(MAX_BIG_VALUE))
         throw new NumberFormatException(MessageFormat.format(_("{0} is not between {1} and {2}."), new Object[] { value, MIN_VALUE, MAX_BIG_VALUE}));
      this.value = a;
      this.top = this.value.shiftRight(32).and(new BigInteger("4294967295")).longValue();
      this.bottom = this.value.and(new BigInteger("4294967295")).longValue();
   }
   /** The value of this as a BigInteger. */
   public BigInteger value() { return value; }
   /** The value of this as a byte. */
   public byte byteValue() { return value.byteValue(); }
   /** The value of this as a double. */
   public double doubleValue() { return value.doubleValue(); }
   /** The value of this as a float. */
   public float floatValue() { return value.floatValue(); }
   /** The value of this as a int. */
   public int intValue() { return value.intValue(); }
   /** The value of this as a long. */
   public long longValue() { return value.longValue(); }
   /** The value of this as a short. */
   public short shortValue(){ return value.shortValue(); }
   /** Test two UInt64s for equality. */
   public boolean equals(Object o)
   {
      return o instanceof UInt64 && this.value.equals(((UInt64) o).value);
   }
   public int hashCode()
   {
      return value.hashCode();
   }
   /** Compare two UInt32s. 
    * @return 0 if equal, -ve or +ve if they are different. 
    */
   public int compareTo(UInt64 other)
   {
      return this.value.compareTo(other.value);
   }
   /** The value of this as a string. */
   public String toString()
   {
      return value.toString();
   }
   /**
    * Most significant 4 bytes.
    */
   public long top()
   {
      return top;
   }
   /**
    * Least significant 4 bytes.
    */
   public long bottom()
   {
      return bottom;
   }
}