001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 * 
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 * 
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.lang3.mutable;
018
019import org.apache.commons.lang3.math.NumberUtils;
020
021/**
022 * A mutable <code>short</code> wrapper.
023 * <p>
024 * Note that as MutableShort does not extend Short, it is not treated by String.format as a Short parameter. 
025 * 
026 * @see Short
027 * @since 2.1
028 * @version $Id: MutableShort.java 1669791 2015-03-28 15:22:59Z britter $
029 */
030public class MutableShort extends Number implements Comparable<MutableShort>, Mutable<Number> {
031
032    /**
033     * Required for serialization support.
034     * 
035     * @see java.io.Serializable
036     */
037    private static final long serialVersionUID = -2135791679L;
038
039    /** The mutable value. */
040    private short value;
041
042    /**
043     * Constructs a new MutableShort with the default value of zero.
044     */
045    public MutableShort() {
046        super();
047    }
048
049    /**
050     * Constructs a new MutableShort with the specified value.
051     * 
052     * @param value  the initial value to store
053     */
054    public MutableShort(final short value) {
055        super();
056        this.value = value;
057    }
058
059    /**
060     * Constructs a new MutableShort with the specified value.
061     * 
062     * @param value  the initial value to store, not null
063     * @throws NullPointerException if the object is null
064     */
065    public MutableShort(final Number value) {
066        super();
067        this.value = value.shortValue();
068    }
069
070    /**
071     * Constructs a new MutableShort parsing the given string.
072     * 
073     * @param value  the string to parse, not null
074     * @throws NumberFormatException if the string cannot be parsed into a short
075     * @since 2.5
076     */
077    public MutableShort(final String value) throws NumberFormatException {
078        super();
079        this.value = Short.parseShort(value);
080    }
081
082    //-----------------------------------------------------------------------
083    /**
084     * Gets the value as a Short instance.
085     * 
086     * @return the value as a Short, never null
087     */
088    @Override
089    public Short getValue() {
090        return Short.valueOf(this.value);
091    }
092
093    /**
094     * Sets the value.
095     * 
096     * @param value  the value to set
097     */
098    public void setValue(final short value) {
099        this.value = value;
100    }
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        this.value = value.shortValue();
111    }
112
113    //-----------------------------------------------------------------------
114    /**
115     * Increments the value.
116     *
117     * @since Commons Lang 2.2
118     */
119    public void increment() {
120        value++;
121    }
122
123    /**
124     * Decrements the value.
125     *
126     * @since Commons Lang 2.2
127     */
128    public void decrement() {
129        value--;
130    }
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 short operand) {
140        this.value += operand;
141    }
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        this.value += operand.shortValue();
152    }
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 short operand) {
161        this.value -= operand;
162    }
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        this.value -= operand.shortValue();
173    }
174
175    //-----------------------------------------------------------------------
176    // byteValue relies on Number implementation
177    /**
178     * Returns the value of this MutableShort as a short.
179     *
180     * @return the numeric value represented by this object after conversion to type short.
181     */
182    @Override
183    public short shortValue() {
184        return value;
185    }
186
187    /**
188     * Returns the value of this MutableShort as an int.
189     *
190     * @return the numeric value represented by this object after conversion to type int.
191     */
192    @Override
193    public int intValue() {
194        return value;
195    }
196
197    /**
198     * Returns the value of this MutableShort as a long.
199     *
200     * @return the numeric value represented by this object after conversion to type long.
201     */
202    @Override
203    public long longValue() {
204        return value;
205    }
206
207    /**
208     * Returns the value of this MutableShort as a float.
209     *
210     * @return the numeric value represented by this object after conversion to type float.
211     */
212    @Override
213    public float floatValue() {
214        return value;
215    }
216
217    /**
218     * Returns the value of this MutableShort as a double.
219     *
220     * @return the numeric value represented by this object after conversion to type double.
221     */
222    @Override
223    public double doubleValue() {
224        return value;
225    }
226
227    //-----------------------------------------------------------------------
228    /**
229     * Gets this mutable as an instance of Short.
230     *
231     * @return a Short instance containing the value from this mutable, never null
232     */
233    public Short toShort() {
234        return Short.valueOf(shortValue());
235    }
236
237    //-----------------------------------------------------------------------
238    /**
239     * Compares this object to the specified object. The result is <code>true</code> if and only if the argument
240     * is not <code>null</code> and is a <code>MutableShort</code> object that contains the same <code>short</code>
241     * value as this object.
242     * 
243     * @param obj  the object to compare with, null returns false
244     * @return <code>true</code> if the objects are the same; <code>false</code> otherwise.
245     */
246    @Override
247    public boolean equals(final Object obj) {
248        if (obj instanceof MutableShort) {
249            return value == ((MutableShort) obj).shortValue();
250        }
251        return false;
252    }
253
254    /**
255     * Returns a suitable hash code for this mutable.
256     * 
257     * @return a suitable hash code
258     */
259    @Override
260    public int hashCode() {
261        return value;
262    }
263
264    //-----------------------------------------------------------------------
265    /**
266     * Compares this mutable to another in ascending order.
267     * 
268     * @param other  the other mutable to compare to, not null
269     * @return negative if this is less, zero if equal, positive if greater
270     */
271    @Override
272    public int compareTo(final MutableShort other) {
273        return NumberUtils.compare(this.value, other.value);
274    }
275
276    //-----------------------------------------------------------------------
277    /**
278     * Returns the String value of this mutable.
279     * 
280     * @return the mutable value as a string
281     */
282    @Override
283    public String toString() {
284        return String.valueOf(value);
285    }
286
287}