org.jgrapht.util.ModifiableInteger Maven / Gradle / Ivy
/*
* (C) Copyright 2002-2021, by Barak Naveh and Contributors.
*
* JGraphT : a free Java graph-theory library
*
* See the CONTRIBUTORS.md file distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0, or the
* GNU Lesser General Public License v2.1 or later
* which is available at
* http://www.gnu.org/licenses/old-licenses/lgpl-2.1-standalone.html.
*
* SPDX-License-Identifier: EPL-2.0 OR LGPL-2.1-or-later
*/
package org.jgrapht.util;
/**
* The ModifiableInteger class wraps a value of the primitive type int in
* an object, similarly to {@link java.lang.Integer}. An object of type
* ModifiableInteger contains a single field whose type is int.
*
*
* Unlike java.lang.Integer, the int value which the ModifiableInteger represents can
* be modified. It becomes useful when used together with the collection framework. For example, if
* you want to have a {@link java.util.List} of counters. You could use Integer but
* that would have became wasteful and inefficient if you frequently had to update the counters.
*
*
*
* WARNING: Because instances of this class are mutable, great care must be exercised if used as
* keys of a {@link java.util.Map} or as values in a {@link java.util.Set} in a manner that affects
* equals comparisons while the instances are keys in the map (or values in the set). For more see
* documentation of Map and Set.
*
*
* @author Barak Naveh
*/
public class ModifiableInteger
extends
Number
implements
Comparable
{
private static final long serialVersionUID = 3618698612851422261L;
/**
* The int value represented by this ModifiableInteger.
*/
public int value;
/**
* !!! DON'T USE - Use the {@link #ModifiableInteger(int)} constructor instead !!!
*
*
* This constructor is for the use of java.beans.XMLDecoder deserialization. The constructor is
* marked as 'deprecated' to indicate to the programmer against using it by mistake.
*
*
* @deprecated not really deprecated, just marked so to avoid mistaken use.
*/
@Deprecated
public ModifiableInteger()
{
}
/**
* Constructs a newly allocated ModifiableInteger object that represents the
* specified int value.
*
* @param value the value to be represented by the
* ModifiableInteger object.
*/
public ModifiableInteger(int value)
{
this.value = value;
}
/**
* Sets a new value for this modifiable integer.
*
* @param value the new value to set.
*/
public void setValue(int value)
{
this.value = value;
}
/**
* Returns the value of this object, similarly to {@link #intValue()}. This getter is NOT
* redundant. It is used for serialization by java.beans.XMLEncoder.
*
* @return the value.
*/
public int getValue()
{
return this.value;
}
/**
* Adds one to the value of this modifiable integer.
*/
public void increment()
{
this.value++;
}
/**
* Subtracts one from the value of this modifiable integer.
*/
public void decrement()
{
this.value--;
}
/**
* Compares two ModifiableInteger objects numerically.
*
* @param anotherInteger the ModifiableInteger to be compared.
*
* @return the value 0 if this ModifiableInteger is equal to the
* argument ModifiableInteger; a value less than 0 if this
* ModifiableInteger is numerically less than the argument
* ModifiableInteger; and a value greater than 0 if this
* ModifiableInteger is numerically greater than the argument
* ModifiableInteger (signed comparison).
*/
@Override
public int compareTo(ModifiableInteger anotherInteger)
{
int thisVal = this.value;
int anotherVal = anotherInteger.value;
return Integer.compare(thisVal, anotherVal);
}
/**
* @see Number#doubleValue()
*/
@Override
public double doubleValue()
{
return this.value;
}
/**
* Compares this object to the specified object. The result is
* true if and only if the argument is not null and is an
* ModifiableInteger object that contains the same
* int value as this object.
*
* @param o the object to compare with.
*
* @return true if the objects are the same; false otherwise.
*/
@Override
public boolean equals(Object o)
{
if (o instanceof ModifiableInteger) {
return this.value == ((ModifiableInteger) o).value;
}
return false;
}
/**
* @see Number#floatValue()
*/
@Override
public float floatValue()
{
return this.value;
}
/**
* Returns a hash code for this ModifiableInteger.
*
* @return a hash code value for this object, equal to the primitive
* int value represented by this ModifiableInteger object.
*/
@Override
public int hashCode()
{
return this.value;
}
/**
* @see Number#intValue()
*/
@Override
public int intValue()
{
return this.value;
}
/**
* @see Number#longValue()
*/
@Override
public long longValue()
{
return this.value;
}
/**
* Returns an Integer object representing this
* ModifiableInteger's value.
*
* @return an Integer representation of the value of this object.
*/
public Integer toInteger()
{
return this.value;
}
/**
* Returns a String object representing this
* ModifiableInteger's value. The value is converted to signed decimal representation and
* returned as a string, exactly as if the integer value were given as an argument to the
* {@link java.lang.Integer#toString(int)} method.
*
* @return a string representation of the value of this object in base 10.
*/
@Override
public String toString()
{
return String.valueOf(this.value);
}
}