net.algart.arrays.ObjectInPlaceArray Maven / Gradle / Ivy
Show all versions of algart Show documentation
/*
* The MIT License (MIT)
*
* Copyright (c) 2007-2024 Daniel Alievsky, AlgART Laboratory (http://algart.net)
*
* 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 net.algart.arrays;
/**
* Special version of {@link ObjectArray} allowing
* to load an element without creating new Java object.
*
* The arrays of object created via some {@link MemoryModel memory models} may not implement this interface.
* You may check, is this interface implemented, by intstanceof operator.
*
* @param the generic type of array elements.
*
* @author Daniel Alievsky
*/
public interface ObjectInPlaceArray extends ObjectArray {
/**
* Copies the content of element #index to the passed resultValue
* and returns resultValue. Never returns {@code null}.
*
* This method may work much faster than {@link #getElement(long)} in long loops,
* because allows to avoid allocating Java objects in the heap.
*
* @return a reference to resultValue.
* @param index index of element to load.
* @param resultValue the object where the retrieved content will be stored.
* @throws IndexOutOfBoundsException if index out of range 0..length()-1.
* @throws NullPointerException if resultValue is {@code null}.
*/
E getInPlace(long index, Object resultValue);
/**
* Creates one instance of {@link #elementType()} class in some state.
* This method, for example, may be used before a loop of calls of
* {@link #getInPlace(long, Object)}.
*
* @return some instance of {@link #elementType()} class
*/
E allocateElement();
}