com.github.stephengold.joltjni.template.Array Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jolt-jni-MacOSX64 Show documentation
a JNI interface to Jolt Physics
The newest version!
/*
Copyright (c) 2024 Stephen Gold

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 */
package com.github.stephengold.joltjni.template;

import com.github.stephengold.joltjni.JoltPhysicsObject;
import java.util.ArrayList;
import java.util.List;

/**
 * A variable-length array of elements.
 *
 * @author Stephen Gold [email protected]
 * @param  the specific type of element
 */
abstract public class Array
        extends JoltPhysicsObject {
    // *************************************************************************
    // constructors

    /**
     * Instantiate an array with no native object assigned.
     */
    protected Array() {
    }

    /**
     * Instantiate with the specified container and native object.
     *
     * @param container the containing object, or {@code null} if none
     * @param virtualAddress the virtual address of the native object to assign
     * (not zero)
     */
    protected Array(JoltPhysicsObject container, long virtualAddress) {
        super(container, virtualAddress);
    }
    // *************************************************************************
    // new methods exposed

    /**
     * Count how many elements the currently allocated storage can hold. The
     * array is unaffected.
     *
     * @return the number of elements (≥size)
     */
    abstract public int capacity();

    /**
     * Destroy all elements and set the size to zero.
     */
    public void clear() {
        resize(0);
    }

    /**
     * Test whether the array contains one or more elements. The array is
     * unaffected.
     *
     * @return {@code true} if empty, otherwise {@code false}
     */
    public boolean empty() {
        if (size() == 0) {
            return true;
        } else {
            return false;
        }
    }

    /**
     * Remove the specified element.
     *
     * @param elementIndex the index of the element to remove (≥0)
     */
    public void erase(int elementIndex) {
        erase(elementIndex, elementIndex + 1);
    }

    /**
     * Remove all elements in the specified range of indices.
     *
     * @param startIndex the index of the first element to remove (≥0)
     * @param stopIndex one plus the index of the last element to remove (≥0)
     */
    abstract public void erase(int startIndex, int stopIndex);

    /**
     * Access or copy the element at the specified index.
     *
     * @param elementIndex the index from which to get the element (≥0)
     * @return a new JVM object
     */
    abstract public T get(int elementIndex);

    /**
     * Expand or truncate the array.
     *
     * @param numElements the desired size (number of elements, ≥0)
     */
    abstract public void resize(int numElements);

    /**
     * Append the specified object to the end.
     *
     * @param object the object to append (not null)
     */
    public void pushBack(T object) {
        int numElements = size();
        resize(numElements + 1);
        set(numElements, object);
    }

    /**
     * Put or duplicate the specified object at the specified index.
     *
     * @param elementIndex the index at which to put the object (≥0)
     * @param object the object to put or duplicate (not null)
     */
    abstract public void set(int elementIndex, T object);

    /**
     * Count how many elements are in the array. The array is unaffected.
     *
     * @return the number of elements (≥0, ≤capacity)
     */
    abstract public int size();

    /**
     * Copy all the elements (in order) to a Java list.
     *
     * @return a new Java list
     */
    public List toList() {
        int numElements = size();
        List result = new ArrayList<>(numElements);
        for (int i = 0; i < numElements; ++i) {
            T element = get(i);
            result.add(element);
        }

        return result;
    }
}