Coverage Report - org.apache.commons.lang3.mutable.MutableLong
 
Classes in this File Line Coverage Branch Coverage Complexity
MutableLong
98%
59/60
100%
4/4
1,067
 
 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  0
 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  6
         super();
 46  6
     }
 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  76
         super();
 55  76
         this.value = value;
 56  76
     }
 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  6
         super();
 66  6
         this.value = value.longValue();
 67  4
     }
 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  2
         super();
 78  2
         this.value = Long.parseLong(value);
 79  2
     }
 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  8
         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  2
         this.value = value;
 99  2
     }
 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  6
         this.value = value.longValue();
 110  4
     }
 111  
 
 112  
     //-----------------------------------------------------------------------
 113  
     /**
 114  
      * Increments the value.
 115  
      *
 116  
      * @since Commons Lang 2.2
 117  
      */
 118  
     public void increment() {
 119  2
         value++;
 120  2
     }
 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  2
         long last = value;
 131  2
         value++;
 132  2
         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  2
         value++;
 144  2
         return value;
 145  
     }
 146  
 
 147  
     /**
 148  
      * Decrements the value.
 149  
      *
 150  
      * @since Commons Lang 2.2
 151  
      */
 152  
     public void decrement() {
 153  2
         value--;
 154  2
     }
 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  2
         long last = value;
 165  2
         value--;
 166  2
         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  2
         value--;
 178  2
         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  2
         this.value += operand;
 190  2
     }
 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  2
         this.value += operand.longValue();
 201  2
     }
 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  2
         this.value -= operand;
 211  2
     }
 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  2
         this.value -= operand.longValue();
 222  2
     }
 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  
      */
 231  
     public long addAndGet(final long operand) {
 232  2
         this.value += operand;
 233  2
         return value;
 234  
     }
 235  
 
 236  
     /**
 237  
      * Increments this instance's value by {@code operand}; this method returns the value associated with the instance
 238  
      * immediately after the addition operation. This method is not thread safe.
 239  
      *
 240  
      * @param operand the quantity to add, not null
 241  
      * @throws NullPointerException if {@code operand} is null
 242  
      * @return the value associated with this instance after adding the operand
 243  
      */
 244  
     public long addAndGet(final Number operand) {
 245  2
         this.value += operand.longValue();
 246  2
         return value;
 247  
     }
 248  
 
 249  
     /**
 250  
      * Increments this instance's value by {@code operand}; this method returns the value associated with the instance
 251  
      * immediately prior to the addition operation. This method is not thread safe.
 252  
      *
 253  
      * @param operand the quantity to add, not null
 254  
      * @return the value associated with this instance immediately before the operand was added
 255  
      */
 256  
     public long getAndAdd(final long operand) {
 257  2
         long last = value;
 258  2
         this.value += operand;
 259  2
         return last;
 260  
     }
 261  
 
 262  
     /**
 263  
      * Increments this instance's value by {@code operand}; this method returns the value associated with the instance
 264  
      * immediately prior to the addition operation. This method is not thread safe.
 265  
      *
 266  
      * @param operand the quantity to add, not null
 267  
      * @throws NullPointerException if {@code operand} is null
 268  
      * @return the value associated with this instance immediately before the operand was added
 269  
      */
 270  
     public long getAndAdd(final Number operand) {
 271  2
         long last = value;
 272  2
         this.value += operand.longValue();
 273  2
         return last;
 274  
     }
 275  
 
 276  
     //-----------------------------------------------------------------------
 277  
     // shortValue and byteValue rely on Number implementation
 278  
     /**
 279  
      * Returns the value of this MutableLong as an int.
 280  
      *
 281  
      * @return the numeric value represented by this object after conversion to type int.
 282  
      */
 283  
     @Override
 284  
     public int intValue() {
 285  30
         return (int) value;
 286  
     }
 287  
 
 288  
     /**
 289  
      * Returns the value of this MutableLong as a long.
 290  
      *
 291  
      * @return the numeric value represented by this object after conversion to type long.
 292  
      */
 293  
     @Override
 294  
     public long longValue() {
 295  70
         return value;
 296  
     }
 297  
 
 298  
     /**
 299  
      * Returns the value of this MutableLong as a float.
 300  
      *
 301  
      * @return the numeric value represented by this object after conversion to type float.
 302  
      */
 303  
     @Override
 304  
     public float floatValue() {
 305  2
         return value;
 306  
     }
 307  
 
 308  
     /**
 309  
      * Returns the value of this MutableLong as a double.
 310  
      *
 311  
      * @return the numeric value represented by this object after conversion to type double.
 312  
      */
 313  
     @Override
 314  
     public double doubleValue() {
 315  2
         return value;
 316  
     }
 317  
 
 318  
     //-----------------------------------------------------------------------
 319  
     /**
 320  
      * Gets this mutable as an instance of Long.
 321  
      *
 322  
      * @return a Long instance containing the value from this mutable, never null
 323  
      */
 324  
     public Long toLong() {
 325  4
         return Long.valueOf(longValue());
 326  
     }
 327  
 
 328  
     //-----------------------------------------------------------------------
 329  
     /**
 330  
      * Compares this object to the specified object. The result is <code>true</code> if and only if the argument
 331  
      * is not <code>null</code> and is a <code>MutableLong</code> object that contains the same <code>long</code>
 332  
      * value as this object.
 333  
      * 
 334  
      * @param obj  the object to compare with, null returns false
 335  
      * @return <code>true</code> if the objects are the same; <code>false</code> otherwise.
 336  
      */
 337  
     @Override
 338  
     public boolean equals(final Object obj) {
 339  20
         if (obj instanceof MutableLong) {
 340  14
             return value == ((MutableLong) obj).longValue();
 341  
         }
 342  6
         return false;
 343  
     }
 344  
 
 345  
     /**
 346  
      * Returns a suitable hash code for this mutable.
 347  
      * 
 348  
      * @return a suitable hash code
 349  
      */
 350  
     @Override
 351  
     public int hashCode() {
 352  14
         return (int) (value ^ (value >>> 32));
 353  
     }
 354  
 
 355  
     //-----------------------------------------------------------------------
 356  
     /**
 357  
      * Compares this mutable to another in ascending order.
 358  
      * 
 359  
      * @param other  the other mutable to compare to, not null
 360  
      * @return negative if this is less, zero if equal, positive if greater
 361  
      */
 362  
     @Override
 363  
     public int compareTo(final MutableLong other) {
 364  8
         return NumberUtils.compare(this.value, other.value);
 365  
     }
 366  
 
 367  
     //-----------------------------------------------------------------------
 368  
     /**
 369  
      * Returns the String value of this mutable.
 370  
      * 
 371  
      * @return the mutable value as a string
 372  
      */
 373  
     @Override
 374  
     public String toString() {
 375  6
         return String.valueOf(value);
 376  
     }
 377  
 
 378  
 }