/* 
 * esodata - data structures and other things, of varying utility
 * Copyright 2022, Ben Culkin
 * 
 * This program 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 3 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
package bjc.data;

/**
 * Utility class for ints by ref.
 *
 * @author Ben Culkin
 */
public class IntHolder {
	/**
	 * The int value.
	 */
	public int val;

	/**
	 * Create a new int-holder set to 0.
	 */
	public IntHolder() {
		val = 0;
	}

	/**
	 * Create a new int-holder set to a value.
	 *
	 * @param i
	 *          The value to set the int to.
	 */
	public IntHolder(int i) {
		val = i;
	}

	/**
	 * Increment the value by one, and return it.
	 *
	 * @return The value of the holder.
	 */
	public int incr() {
		return incr(1);
	}

	/**
	 * Increment the value by an amount and return it.
	 *
	 * @param i
	 *          The amount to increment by.
	 *
	 * @return The value of the holder.
	 */
	public int incr(int i) {
		val += 1;

		return val;
	}

	/**
	 * Get the value.
	 *
	 * @return The value.
	 */
	public int get() {
		return val;
	}

	/**
	 * Set the value.
	 *
	 * @param i
	 *          The value to set it to.
	 */
	public void set(int i) {
		val = i;
	}
}