Class CXFileUniqueID

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer

    public class CXFileUniqueID
    extends Struct
    implements NativeResource
    Uniquely identifies a CXFile, that refers to the same underlying file, across an indexing session.

    Layout

    
     struct CXFileUniqueID {
         unsigned long long data[3];
     }
    • Field Detail

      • SIZEOF

        public static final int SIZEOF
        The struct size in bytes.
      • ALIGNOF

        public static final int ALIGNOF
        The struct alignment in bytes.
      • DATA

        public static final int DATA
        The struct member offsets.
    • Constructor Detail

      • CXFileUniqueID

        public CXFileUniqueID​(java.nio.ByteBuffer container)
        Creates a CXFileUniqueID instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

        The created instance holds a strong reference to the container object.

    • Method Detail

      • sizeof

        public int sizeof()
        Description copied from class: Struct
        Returns sizeof(struct).
        Specified by:
        sizeof in class Struct
      • data

        public java.nio.LongBuffer data()
        Returns a LongBuffer view of the data field.
      • data

        public long data​(int index)
        Returns the value at the specified index of the data field.
      • malloc

        public static CXFileUniqueID malloc()
        Returns a new CXFileUniqueID instance allocated with memAlloc. The instance must be explicitly freed.
      • calloc

        public static CXFileUniqueID calloc()
        Returns a new CXFileUniqueID instance allocated with memCalloc. The instance must be explicitly freed.
      • create

        public static CXFileUniqueID create​(long address)
        Returns a new CXFileUniqueID instance for the specified memory address.
      • createSafe

        @Nullable
        public static CXFileUniqueID createSafe​(long address)
        Like create, but returns null if address is NULL.
      • create

        public static CXFileUniqueID.Buffer create​(long address,
                                                   int capacity)
        Create a CXFileUniqueID.Buffer instance at the specified memory.
        Parameters:
        address - the memory address
        capacity - the buffer capacity
      • createSafe

        @Nullable
        public static CXFileUniqueID.Buffer createSafe​(long address,
                                                       int capacity)
        Like create, but returns null if address is NULL.
      • mallocStack

        public static CXFileUniqueID mallocStack()
        Returns a new CXFileUniqueID instance allocated on the thread-local MemoryStack.
      • callocStack

        public static CXFileUniqueID callocStack()
        Returns a new CXFileUniqueID instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      • mallocStack

        public static CXFileUniqueID mallocStack​(MemoryStack stack)
        Returns a new CXFileUniqueID instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
      • callocStack

        public static CXFileUniqueID callocStack​(MemoryStack stack)
        Returns a new CXFileUniqueID instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
      • ndata

        public static java.nio.LongBuffer ndata​(long struct)
        Unsafe version of data().
      • ndata

        public static long ndata​(long struct,
                                 int index)
        Unsafe version of data.