View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.lang3.mutable;
18  
19  import org.apache.commons.lang3.math.NumberUtils;
20  
21  /**
22   * A mutable <code>long</code> wrapper.
23   * <p>
24   * Note that as MutableLong does not extend Long, it is not treated by String.format as a Long parameter. 
25   * 
26   * @see Long
27   * @since 2.1
28   */
29  public class MutableLong extends Number implements Comparable<MutableLong>, Mutable<Number> {
30  
31      /**
32       * Required for serialization support.
33       * 
34       * @see java.io.Serializable
35       */
36      private static final long serialVersionUID = 62986528375L;
37  
38      /** The mutable value. */
39      private long value;
40  
41      /**
42       * Constructs a new MutableLong with the default value of zero.
43       */
44      public MutableLong() {
45          super();
46      }
47  
48      /**
49       * Constructs a new MutableLong with the specified value.
50       * 
51       * @param value  the initial value to store
52       */
53      public MutableLong(final long value) {
54          super();
55          this.value = value;
56      }
57  
58      /**
59       * Constructs a new MutableLong with the specified value.
60       * 
61       * @param value  the initial value to store, not null
62       * @throws NullPointerException if the object is null
63       */
64      public MutableLong(final Number value) {
65          super();
66          this.value = value.longValue();
67      }
68  
69      /**
70       * Constructs a new MutableLong parsing the given string.
71       * 
72       * @param value  the string to parse, not null
73       * @throws NumberFormatException if the string cannot be parsed into a long
74       * @since 2.5
75       */
76      public MutableLong(final String value) throws NumberFormatException {
77          super();
78          this.value = Long.parseLong(value);
79      }
80  
81      //-----------------------------------------------------------------------
82      /**
83       * Gets the value as a Long instance.
84       * 
85       * @return the value as a Long, never null
86       */
87      @Override
88      public Long getValue() {
89          return Long.valueOf(this.value);
90      }
91  
92      /**
93       * Sets the value.
94       * 
95       * @param value  the value to set
96       */
97      public void setValue(final long value) {
98          this.value = value;
99      }
100 
101     /**
102      * Sets the value from any Number instance.
103      * 
104      * @param value  the value to set, not null
105      * @throws NullPointerException if the object is null
106      */
107     @Override
108     public void setValue(final Number value) {
109         this.value = value.longValue();
110     }
111 
112     //-----------------------------------------------------------------------
113     /**
114      * Increments the value.
115      *
116      * @since Commons Lang 2.2
117      */
118     public void increment() {
119         value++;
120     }
121 
122     /**
123      * Increments this instance's value by 1; this method returns the value associated with the instance
124      * immediately prior to the increment operation. This method is not thread safe.
125      *
126      * @return the value associated with the instance before it was incremented
127      * @since 3.5
128      */
129     public long getAndIncrement() {
130         long last = value;
131         value++;
132         return last;
133     }
134 
135     /**
136      * Increments this instance's value by 1; this method returns the value associated with the instance
137      * immediately after the increment operation. This method is not thread safe.
138      *
139      * @return the value associated with the instance after it is incremented
140      * @since 3.5
141      */
142     public long incrementAndGet() {
143         value++;
144         return value;
145     }
146 
147     /**
148      * Decrements the value.
149      *
150      * @since Commons Lang 2.2
151      */
152     public void decrement() {
153         value--;
154     }
155 
156     /**
157      * Decrements this instance's value by 1; this method returns the value associated with the instance
158      * immediately prior to the decrement operation. This method is not thread safe.
159      *
160      * @return the value associated with the instance before it was decremented
161      * @since 3.5
162      */
163     public long getAndDecrement() {
164         long last = value;
165         value--;
166         return last;
167     }
168 
169     /**
170      * Decrements this instance's value by 1; this method returns the value associated with the instance
171      * immediately after the decrement operation. This method is not thread safe.
172      *
173      * @return the value associated with the instance after it is decremented
174      * @since 3.5
175      */
176     public long decrementAndGet() {
177         value--;
178         return value;
179     }
180 
181     //-----------------------------------------------------------------------
182     /**
183      * Adds a value to the value of this instance.
184      * 
185      * @param operand  the value to add, not null
186      * @since Commons Lang 2.2
187      */
188     public void add(final long operand) {
189         this.value += operand;
190     }
191 
192     /**
193      * Adds a value to the value of this instance.
194      * 
195      * @param operand  the value to add, not null
196      * @throws NullPointerException if the object is null
197      * @since Commons Lang 2.2
198      */
199     public void add(final Number operand) {
200         this.value += operand.longValue();
201     }
202 
203     /**
204      * Subtracts a value from the value of this instance.
205      * 
206      * @param operand  the value to subtract, not null
207      * @since Commons Lang 2.2
208      */
209     public void subtract(final long operand) {
210         this.value -= operand;
211     }
212 
213     /**
214      * Subtracts a value from the value of this instance.
215      * 
216      * @param operand  the value to subtract, not null
217      * @throws NullPointerException if the object is null
218      * @since Commons Lang 2.2
219      */
220     public void subtract(final Number operand) {
221         this.value -= operand.longValue();
222     }
223 
224     /**
225      * Increments this instance's value by {@code operand}; this method returns the value associated with the instance
226      * immediately after the addition operation. This method is not thread safe.
227      *
228      * @param operand the quantity to add, not null
229      * @return the value associated with this instance after adding the operand
230      * @since 3.5
231      */
232     public long addAndGet(final long operand) {
233         this.value += operand;
234         return value;
235     }
236 
237     /**
238      * Increments this instance's value by {@code operand}; this method returns the value associated with the instance
239      * immediately after the addition operation. This method is not thread safe.
240      *
241      * @param operand the quantity to add, not null
242      * @throws NullPointerException if {@code operand} is null
243      * @return the value associated with this instance after adding the operand
244      * @since 3.5
245      */
246     public long addAndGet(final Number operand) {
247         this.value += operand.longValue();
248         return value;
249     }
250 
251     /**
252      * Increments this instance's value by {@code operand}; this method returns the value associated with the instance
253      * immediately prior to the addition operation. This method is not thread safe.
254      *
255      * @param operand the quantity to add, not null
256      * @return the value associated with this instance immediately before the operand was added
257      * @since 3.5
258      */
259     public long getAndAdd(final long operand) {
260         long last = value;
261         this.value += operand;
262         return last;
263     }
264 
265     /**
266      * Increments this instance's value by {@code operand}; this method returns the value associated with the instance
267      * immediately prior to the addition operation. This method is not thread safe.
268      *
269      * @param operand the quantity to add, not null
270      * @throws NullPointerException if {@code operand} is null
271      * @return the value associated with this instance immediately before the operand was added
272      * @since 3.5
273      */
274     public long getAndAdd(final Number operand) {
275         long last = value;
276         this.value += operand.longValue();
277         return last;
278     }
279 
280     //-----------------------------------------------------------------------
281     // shortValue and byteValue rely on Number implementation
282     /**
283      * Returns the value of this MutableLong as an int.
284      *
285      * @return the numeric value represented by this object after conversion to type int.
286      */
287     @Override
288     public int intValue() {
289         return (int) value;
290     }
291 
292     /**
293      * Returns the value of this MutableLong as a long.
294      *
295      * @return the numeric value represented by this object after conversion to type long.
296      */
297     @Override
298     public long longValue() {
299         return value;
300     }
301 
302     /**
303      * Returns the value of this MutableLong as a float.
304      *
305      * @return the numeric value represented by this object after conversion to type float.
306      */
307     @Override
308     public float floatValue() {
309         return value;
310     }
311 
312     /**
313      * Returns the value of this MutableLong as a double.
314      *
315      * @return the numeric value represented by this object after conversion to type double.
316      */
317     @Override
318     public double doubleValue() {
319         return value;
320     }
321 
322     //-----------------------------------------------------------------------
323     /**
324      * Gets this mutable as an instance of Long.
325      *
326      * @return a Long instance containing the value from this mutable, never null
327      */
328     public Long toLong() {
329         return Long.valueOf(longValue());
330     }
331 
332     //-----------------------------------------------------------------------
333     /**
334      * Compares this object to the specified object. The result is <code>true</code> if and only if the argument
335      * is not <code>null</code> and is a <code>MutableLong</code> object that contains the same <code>long</code>
336      * value as this object.
337      * 
338      * @param obj  the object to compare with, null returns false
339      * @return <code>true</code> if the objects are the same; <code>false</code> otherwise.
340      */
341     @Override
342     public boolean equals(final Object obj) {
343         if (obj instanceof MutableLong) {
344             return value == ((MutableLong) obj).longValue();
345         }
346         return false;
347     }
348 
349     /**
350      * Returns a suitable hash code for this mutable.
351      * 
352      * @return a suitable hash code
353      */
354     @Override
355     public int hashCode() {
356         return (int) (value ^ (value >>> 32));
357     }
358 
359     //-----------------------------------------------------------------------
360     /**
361      * Compares this mutable to another in ascending order.
362      * 
363      * @param other  the other mutable to compare to, not null
364      * @return negative if this is less, zero if equal, positive if greater
365      */
366     @Override
367     public int compareTo(final MutableLong other) {
368         return NumberUtils.compare(this.value, other.value);
369     }
370 
371     //-----------------------------------------------------------------------
372     /**
373      * Returns the String value of this mutable.
374      * 
375      * @return the mutable value as a string
376      */
377     @Override
378     public String toString() {
379         return String.valueOf(value);
380     }
381 
382 }