org.scijava.util.IntArray Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scijava-common Show documentation
SciJava Common is a shared library for SciJava software. It provides a plugin framework, with an extensible mechanism for service discovery, backed by its own annotation processor, so that plugins can be loaded dynamically. It is used by both ImageJ and SCIFIO.
There is a newer version: 2.99.0
Show newest version
/*
 * #%L
 * SciJava Common shared library for SciJava software.
 * %%
 * Copyright (C) 2009 - 2016 Board of Regents of the University of
 * Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
 * Institute of Molecular Cell Biology and Genetics.
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * #L%
 */

package org.scijava.util;

import java.util.Collection;

/**
 * An extensible array of {@code int} elements.
 * 
 * @author Johannes Schindelin
 * @author Curtis Rueden
 */
public class IntArray extends AbstractPrimitiveArray {

	/** The backing array. */
	private int[] array;

	/**
	 * Constructs an extensible array of ints, backed by a fixed-size array.
	 */
	public IntArray() {
		super(Integer.TYPE);
	}

	/**
	 * Constructs an extensible array of ints, backed by a fixed-size array.
	 * 
	 * @param size the initial size
	 */
	public IntArray(final int size) {
		super(Integer.TYPE, size);
	}

	/**
	 * Constructs an extensible array of ints, backed by the given fixed-size
	 * array.
	 * 
	 * @param array the array to wrap
	 */
	public IntArray(final int[] array) {
		super(Integer.TYPE, array);
	}

	// -- IntArray methods --

	public void addValue(final int value) {
		addValue(size(), value);
	}

	public boolean removeValue(final int value) {
		final int index = indexOf(value);
		if (index < 0) return false;
		delete(index, 1);
		return true;
	}

	public int getValue(final int index) {
		checkBounds(index);
		return array[index];
	}

	public int setValue(final int index, final int value) {
		checkBounds(index);
		final int oldValue = getValue(index);
		array[index] = value;
		return oldValue;
	}

	public void addValue(final int index, final int value) {
		insert(index, 1);
		array[index] = value;
	}

	public int indexOf(final int value) {
		for (int i = 0; i < size(); i++) {
			if (array[i] == value) return i;
		}
		return -1;
	}

	public int lastIndexOf(final int value) {
		for (int i = size() - 1; i >= 0; i--) {
			if (array[i] == value) return i;
		}
		return -1;
	}

	public boolean contains(final int value) {
		return indexOf(value) >= 0;
	}

	// -- PrimitiveArray methods --

	@Override
	public int[] getArray() {
		return array;
	}

	@Override
	public void setArray(final int[] array) {
		if (array.length < size()) {
			throw new IllegalArgumentException("Array too small");
		}
		this.array = array;
	}

	// -- List methods --

	@Override
	public Integer get(final int index) {
		return getValue(index);
	}

	@Override
	public Integer set(final int index, final Integer element) {
		return setValue(index, element == null ? defaultValue() : element);
	}

	@Override
	public void add(final int index, final Integer element) {
		addValue(index, element);
	}

	// NB: Overridden for performance.
	@Override
	public int indexOf(final Object o) {
		if (!(o instanceof Integer)) return -1;
		final int value = (Integer) o;
		return indexOf(value);
	}

	// NB: Overridden for performance.
	@Override
	public int lastIndexOf(final Object o) {
		if (!(o instanceof Integer)) return -1;
		final int value = (Integer) o;
		return lastIndexOf(value);
	}

	// -- Collection methods --

	// NB: Overridden for performance.
	@Override
	public boolean contains(final Object o) {
		if (!(o instanceof Integer)) return false;
		final int value = (Integer) o;
		return contains(value);
	}

	// NB: Overridden for performance.
	@Override
	public boolean remove(final Object o) {
		if (!(o instanceof Integer)) return false;
		final int value = (Integer) o;
		return removeValue(value);
	}

	// NB: Overridden for performance.
	@Override
	public boolean containsAll(final Collection c) {
		for (final Object o : c) {
			if (!(o instanceof Integer)) return false;
			final int value = (Integer) o;
			if (indexOf(value) < 0) return false;
		}
		return true;
	}

	// NB: Overridden for performance.
	@Override
	public boolean addAll(final int index, final Collection c)
	{
		if (c.size() == 0) return false;
		insert(index, c.size());
		int i = index;
		for (final int e : c) {
			setValue(i++, e);
		}
		return true;
	}

	// NB: Overridden for performance.
	@Override
	public boolean removeAll(final Collection c) {
		boolean changed = false;
		for (final Object o : c) {
			if (!(o instanceof Integer)) continue;
			final int value = (Integer) o;
			final boolean result = removeValue(value);
			if (result) changed = true;
		}
		return changed;
	}

	@Override
	public Integer defaultValue() {
		return 0;
	}
}