Top Description Inners Fields Constructors Methods
org.lwjgl.util.lz4

public Class LZ4Stream

extends Struct<LZ4Stream>
Class Inheritance
Annotations
@NativeType:union LZ4_stream_t
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Layout


union LZ4_stream_t {
    void * table[LZ4_STREAM_MINSIZE];
    struct LZ4_stream_t_internal internal_donotuse;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
LZ4Stream.Buffer

An array of LZ4Stream structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
INTERNAL_DONOTUSE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TABLE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
LZ4Stream(long address, ByteBuffer container)

public
LZ4Stream(ByteBuffer container)

Creates a LZ4Stream instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
protected LZ4Stream
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static LZ4Stream
create(long address)

Returns a new LZ4Stream instance for the specified memory address.

public static LZ4Stream.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a LZ4Stream.Buffer instance at the specified memory.

public static LZ4Stream
createSafe(long address)

Like create, but returns null if address is NULL.

public static LZ4Stream.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public LZ4StreamInternal

Returns:

a LZ4StreamInternal view of the internal_donotuse field.
internal_donotuse
()

public static LZ4StreamInternal
ninternal_donotuse(long struct)

Unsafe version of internal_donotuse.

public static PointerBuffer
ntable(long struct)

Unsafe version of table.

public static long
ntable(long struct, int index)

Unsafe version of table.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public PointerBuffer

Returns:

a PointerBuffer view of the table field.
table
()

public long

Returns:

the value at the specified index of the table field.
table
(int index)

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

INTERNAL_DONOTUSEback to summary
public static final int INTERNAL_DONOTUSE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TABLEback to summary
public static final int TABLE

The struct member offsets.

Constructor Detail

LZ4Streamback to summary
protected LZ4Stream(long address, ByteBuffer container)
LZ4Streamback to summary
public LZ4Stream(ByteBuffer container)

Creates a LZ4Stream 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

createback to summary
protected LZ4Stream create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static LZ4Stream create(long address)

Returns a new LZ4Stream instance for the specified memory address.

createback to summary
public static LZ4Stream.Buffer create(long address, int capacity)

Create a LZ4Stream.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static LZ4Stream createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static LZ4Stream.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
internal_donotuseback to summary
public LZ4StreamInternal internal_donotuse()
Returns:LZ4StreamInternal

a LZ4StreamInternal view of the internal_donotuse field.

Annotations
@NativeType:struct LZ4_stream_t_internal
ninternal_donotuseback to summary
public static LZ4StreamInternal ninternal_donotuse(long struct)

Unsafe version of internal_donotuse.

ntableback to summary
public static PointerBuffer ntable(long struct)

Unsafe version of table.

ntableback to summary
public static long ntable(long struct, int index)

Unsafe version of table.

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
tableback to summary
public PointerBuffer table()
Returns:PointerBuffer

a PointerBuffer view of the table field.

Annotations
@NativeType:void *[LZ4_STREAM_MINSIZE]
tableback to summary
public long table(int index)
Returns:long

the value at the specified index of the table field.

Annotations
@NativeType:void *
org.lwjgl.util.lz4 back to summary

public Class LZ4Stream.Buffer

extends StructBuffer<LZ4Stream, LZ4Stream.Buffer>
Class Inheritance

An array of LZ4Stream structs.

Field Summary

Modifier and TypeField and Description
private static final LZ4Stream

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new LZ4Stream.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected LZ4Stream
public LZ4StreamInternal

Returns:

a LZ4StreamInternal view of the internal_donotuse field.
internal_donotuse
()

protected LZ4Stream.Buffer
public PointerBuffer

Returns:

a PointerBuffer view of the table field.
table
()

public long

Returns:

the value at the specified index of the table field.
table
(int index)

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final LZ4Stream ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new LZ4Stream.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by LZ4Stream#SIZEOF, and its mark will be undefined.

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

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected LZ4Stream getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
internal_donotuseback to summary
public LZ4StreamInternal internal_donotuse()
Returns:LZ4StreamInternal

a LZ4StreamInternal view of the internal_donotuse field.

Annotations
@NativeType:struct LZ4_stream_t_internal
selfback to summary
protected LZ4Stream.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
tableback to summary
public PointerBuffer table()
Returns:PointerBuffer

a PointerBuffer view of the table field.

Annotations
@NativeType:void *[LZ4_STREAM_MINSIZE]
tableback to summary
public long table(int index)
Returns:long

the value at the specified index of the table field.

Annotations
@NativeType:void *