Class CXString

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

    public class CXString
    extends Struct
    implements NativeResource
    A character string.

    The CXString type is used to return strings from the interface when the ownership of that string might differ from one call to the next. Use getCString to retrieve the string data and, once finished with the string data, call disposeString to free the string.

    Layout

    
     struct CXString {
         void const * data;
         unsigned private_flags;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • DATA, PRIVATE_FLAGS

        The struct member offsets.
    • Constructor Detail

      • CXString

        public CXString​(java.nio.ByteBuffer container)
        Creates a CXString 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.ByteBuffer data​(int capacity)
        Returns a ByteBuffer view of the data pointed to by the data field.
        Parameters:
        capacity - the number of elements in the returned buffer
      • private_flags

        public int private_flags()
        Returns the value of the private_flags field.
      • malloc

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

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

        public static CXString create()
        Returns a new CXString instance allocated with BufferUtils.
      • create

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

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

        public static CXString.Buffer malloc​(int capacity)
        Returns a new CXString.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
        Parameters:
        capacity - the buffer capacity
      • calloc

        public static CXString.Buffer calloc​(int capacity)
        Returns a new CXString.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
        Parameters:
        capacity - the buffer capacity
      • create

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

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

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

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

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

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

        public static CXString.Buffer callocStack​(int capacity)
        Returns a new CXString.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
        Parameters:
        capacity - the buffer capacity
      • callocStack

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

        public static java.nio.ByteBuffer ndata​(long struct,
                                                int capacity)
        Unsafe version of data.
      • nprivate_flags

        public static int nprivate_flags​(long struct)
        Unsafe version of private_flags().