Package nom.tam.util.array

Class MultiArrayPointer

java.lang.Object
nom.tam.util.array.MultiArrayPointer
public class MultiArrayPointer extends Object
Deprecated.
()for internal use) Visibility may be reduced to the package level in the future. A multi-dimensional array index. Used only by MultiArrayCopier and MultiArrayIterator.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Object
    END
    Deprecated.
    A dummy object to mark the end.

  • Constructor Summary

    Constructors
    Constructor
    Description
    MultiArrayPointer()
    Deprecated.
    ()for internal use) Visibility may be reduced to private.
    MultiArrayPointer(Object baseArray)
    Deprecated.
    Constructs a new pointer for the specified multidimensional array object.

  • Method Summary

    Modifier and Type
    Method
    Description
    static boolean
    isSubArray(Object element)
    Deprecated.
    ()for internal use) Visibility may be reduced to private.
    Object
    next()
    Deprecated.
    Returns the next base element in the array
    void
    reset()
    Deprecated.
    Resets the pointer such that next() will return the first element again.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • END

      public static final Object END
      Deprecated.
      A dummy object to mark the end.

  • Constructor Details

    • MultiArrayPointer

      public MultiArrayPointer()
      Deprecated.
      ()for internal use) Visibility may be reduced to private.
      Constructs a new pointer for an unspecified multi-dimensional array object.

    • MultiArrayPointer

      public MultiArrayPointer(Object baseArray)
      Deprecated.
      Constructs a new pointer for the specified multidimensional array object.
      Parameters:
      baseArray - the multidimensional array to iterate over.

  • Method Details

    • next

      public Object next()
      Deprecated.
      Returns the next base element in the array
      Returns:
      the next base element in the array.

    • reset

      public void reset()
      Deprecated.
      Resets the pointer such that next() will return the first element again.

    • isSubArray

      public static boolean isSubArray(Object element)
      Deprecated.
      ()for internal use) Visibility may be reduced to private.
      Checks whether entries in a given element are also arrays themselves.
      Parameters:
      element - the element
      Returns:
      true if the entries in the given element are also arrays, otherwise false.