Coverage Report - org.apache.commons.lang3.mutable.MutableLong
 
Classes in this File Line Coverage Branch Coverage Complexity
MutableLong
97%
39/40
100%
4/4
1,091
 
 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  
  * @version $Id: MutableLong.java 1669791 2015-03-28 15:22:59Z britter $
 29  
  */
 30  0
 public class MutableLong extends Number implements Comparable<MutableLong>, Mutable<Number> {
 31  
 
 32  
     /**
 33  
      * Required for serialization support.
 34  
      * 
 35  
      * @see java.io.Serializable
 36  
      */
 37  
     private static final long serialVersionUID = 62986528375L;
 38  
 
 39  
     /** The mutable value. */
 40  
     private long value;
 41  
 
 42  
     /**
 43  
      * Constructs a new MutableLong with the default value of zero.
 44  
      */
 45  
     public MutableLong() {
 46  3
         super();
 47  3
     }
 48  
 
 49  
     /**
 50  
      * Constructs a new MutableLong with the specified value.
 51  
      * 
 52  
      * @param value  the initial value to store
 53  
      */
 54  
     public MutableLong(final long value) {
 55  30
         super();
 56  30
         this.value = value;
 57  30
     }
 58  
 
 59  
     /**
 60  
      * Constructs a new MutableLong with the specified value.
 61  
      * 
 62  
      * @param value  the initial value to store, not null
 63  
      * @throws NullPointerException if the object is null
 64  
      */
 65  
     public MutableLong(final Number value) {
 66  3
         super();
 67  3
         this.value = value.longValue();
 68  2
     }
 69  
 
 70  
     /**
 71  
      * Constructs a new MutableLong parsing the given string.
 72  
      * 
 73  
      * @param value  the string to parse, not null
 74  
      * @throws NumberFormatException if the string cannot be parsed into a long
 75  
      * @since 2.5
 76  
      */
 77  
     public MutableLong(final String value) throws NumberFormatException {
 78  1
         super();
 79  1
         this.value = Long.parseLong(value);
 80  1
     }
 81  
 
 82  
     //-----------------------------------------------------------------------
 83  
     /**
 84  
      * Gets the value as a Long instance.
 85  
      * 
 86  
      * @return the value as a Long, never null
 87  
      */
 88  
     @Override
 89  
     public Long getValue() {
 90  4
         return Long.valueOf(this.value);
 91  
     }
 92  
 
 93  
     /**
 94  
      * Sets the value.
 95  
      * 
 96  
      * @param value  the value to set
 97  
      */
 98  
     public void setValue(final long value) {
 99  1
         this.value = value;
 100  1
     }
 101  
 
 102  
     /**
 103  
      * Sets the value from any Number instance.
 104  
      * 
 105  
      * @param value  the value to set, not null
 106  
      * @throws NullPointerException if the object is null
 107  
      */
 108  
     @Override
 109  
     public void setValue(final Number value) {
 110  3
         this.value = value.longValue();
 111  2
     }
 112  
 
 113  
     //-----------------------------------------------------------------------
 114  
     /**
 115  
      * Increments the value.
 116  
      *
 117  
      * @since Commons Lang 2.2
 118  
      */
 119  
     public void increment() {
 120  1
         value++;
 121  1
     }
 122  
 
 123  
     /**
 124  
      * Decrements the value.
 125  
      *
 126  
      * @since Commons Lang 2.2
 127  
      */
 128  
     public void decrement() {
 129  1
         value--;
 130  1
     }
 131  
 
 132  
     //-----------------------------------------------------------------------
 133  
     /**
 134  
      * Adds a value to the value of this instance.
 135  
      * 
 136  
      * @param operand  the value to add, not null
 137  
      * @since Commons Lang 2.2
 138  
      */
 139  
     public void add(final long operand) {
 140  1
         this.value += operand;
 141  1
     }
 142  
 
 143  
     /**
 144  
      * Adds a value to the value of this instance.
 145  
      * 
 146  
      * @param operand  the value to add, not null
 147  
      * @throws NullPointerException if the object is null
 148  
      * @since Commons Lang 2.2
 149  
      */
 150  
     public void add(final Number operand) {
 151  1
         this.value += operand.longValue();
 152  1
     }
 153  
 
 154  
     /**
 155  
      * Subtracts a value from the value of this instance.
 156  
      * 
 157  
      * @param operand  the value to subtract, not null
 158  
      * @since Commons Lang 2.2
 159  
      */
 160  
     public void subtract(final long operand) {
 161  1
         this.value -= operand;
 162  1
     }
 163  
 
 164  
     /**
 165  
      * Subtracts a value from the value of this instance.
 166  
      * 
 167  
      * @param operand  the value to subtract, not null
 168  
      * @throws NullPointerException if the object is null
 169  
      * @since Commons Lang 2.2
 170  
      */
 171  
     public void subtract(final Number operand) {
 172  1
         this.value -= operand.longValue();
 173  1
     }
 174  
 
 175  
     //-----------------------------------------------------------------------
 176  
     // shortValue and byteValue rely on Number implementation
 177  
     /**
 178  
      * Returns the value of this MutableLong as an int.
 179  
      *
 180  
      * @return the numeric value represented by this object after conversion to type int.
 181  
      */
 182  
     @Override
 183  
     public int intValue() {
 184  11
         return (int) value;
 185  
     }
 186  
 
 187  
     /**
 188  
      * Returns the value of this MutableLong as a long.
 189  
      *
 190  
      * @return the numeric value represented by this object after conversion to type long.
 191  
      */
 192  
     @Override
 193  
     public long longValue() {
 194  27
         return value;
 195  
     }
 196  
 
 197  
     /**
 198  
      * Returns the value of this MutableLong as a float.
 199  
      *
 200  
      * @return the numeric value represented by this object after conversion to type float.
 201  
      */
 202  
     @Override
 203  
     public float floatValue() {
 204  1
         return value;
 205  
     }
 206  
 
 207  
     /**
 208  
      * Returns the value of this MutableLong as a double.
 209  
      *
 210  
      * @return the numeric value represented by this object after conversion to type double.
 211  
      */
 212  
     @Override
 213  
     public double doubleValue() {
 214  1
         return value;
 215  
     }
 216  
 
 217  
     //-----------------------------------------------------------------------
 218  
     /**
 219  
      * Gets this mutable as an instance of Long.
 220  
      *
 221  
      * @return a Long instance containing the value from this mutable, never null
 222  
      */
 223  
     public Long toLong() {
 224  2
         return Long.valueOf(longValue());
 225  
     }
 226  
 
 227  
     //-----------------------------------------------------------------------
 228  
     /**
 229  
      * Compares this object to the specified object. The result is <code>true</code> if and only if the argument
 230  
      * is not <code>null</code> and is a <code>MutableLong</code> object that contains the same <code>long</code>
 231  
      * value as this object.
 232  
      * 
 233  
      * @param obj  the object to compare with, null returns false
 234  
      * @return <code>true</code> if the objects are the same; <code>false</code> otherwise.
 235  
      */
 236  
     @Override
 237  
     public boolean equals(final Object obj) {
 238  10
         if (obj instanceof MutableLong) {
 239  7
             return value == ((MutableLong) obj).longValue();
 240  
         }
 241  3
         return false;
 242  
     }
 243  
 
 244  
     /**
 245  
      * Returns a suitable hash code for this mutable.
 246  
      * 
 247  
      * @return a suitable hash code
 248  
      */
 249  
     @Override
 250  
     public int hashCode() {
 251  7
         return (int) (value ^ (value >>> 32));
 252  
     }
 253  
 
 254  
     //-----------------------------------------------------------------------
 255  
     /**
 256  
      * Compares this mutable to another in ascending order.
 257  
      * 
 258  
      * @param other  the other mutable to compare to, not null
 259  
      * @return negative if this is less, zero if equal, positive if greater
 260  
      */
 261  
     @Override
 262  
     public int compareTo(final MutableLong other) {
 263  4
         return NumberUtils.compare(this.value, other.value);
 264  
     }
 265  
 
 266  
     //-----------------------------------------------------------------------
 267  
     /**
 268  
      * Returns the String value of this mutable.
 269  
      * 
 270  
      * @return the mutable value as a string
 271  
      */
 272  
     @Override
 273  
     public String toString() {
 274  3
         return String.valueOf(value);
 275  
     }
 276  
 
 277  
 }