org.qedeq.base.utility.Enumerator Maven / Gradle / Ivy
/* This file is part of the project "Hilbert II" - http://www.qedeq.org
*
* Copyright 2000-2013, Michael Meyling .
*
* "Hilbert II" is free software; you can redistribute
* it and/or modify it under the terms of the GNU General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*/
package org.qedeq.base.utility;
/**
* An object of this class represents a number, that could be
* compared and increased.
*
* @author Michael Meyling
*/
public final class Enumerator {
/** The plain number. */
private int number;
/**
* Constructs an object with 0 as start number.
*/
public Enumerator() {
number = 0;
}
/**
* Constructs an object with given start number.
*
* @param number Start value.
*/
public Enumerator(final int number) {
this.number = number;
}
/**
* Gets current number.
*
* @return Current number.
*/
public final int getNumber() {
return number;
}
/**
* Reset counter to zero.
*/
public final void reset() {
number = 0;
}
/**
* Increases current number by one.
*/
public final void increaseNumber() {
number++;
}
public final boolean equals(final Object object) {
if (object == null || !(object instanceof Enumerator)) {
return false;
}
return getNumber() == ((Enumerator) object).getNumber();
}
public final int hashCode() {
return number;
}
/**
* Return number in String format.
*
* @return Number as String.
*/
public final String toString() {
return Integer.toString(number);
}
}