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

public Class LZ4StreamInternal

extends Struct<LZ4StreamInternal>
Class Inheritance
Annotations
@NativeType:struct LZ4_stream_t_internal
Imports
javax.annotation.*, java.nio.*, org.lwjgl.system.*

Layout


struct LZ4_stream_t_internal {
    LZ4_u32 hashTable[LZ4_HASH_SIZE_U32];
    LZ4_byte const * dictionary;
    LZ4_stream_t_internal * const dictCtx;
    LZ4_u32 currentOffset;
    LZ4_u32 tableType;
    LZ4_u32 dictSize;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CURRENTOFFSET

The struct member offsets.

public static final int
DICTCTX

The struct member offsets.

public static final int
DICTIONARY

The struct member offsets.

public static final int
DICTSIZE

The struct member offsets.

public static final int
HASHTABLE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TABLETYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
LZ4StreamInternal(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
protected LZ4StreamInternal
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 LZ4StreamInternal
create(long address)

Returns a new LZ4StreamInternal instance for the specified memory address.

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

Create a LZ4StreamInternal.Buffer instance at the specified memory.

public static LZ4StreamInternal
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int

Returns:

the value of the currentOffset field.
currentOffset
()

public LZ4StreamInternal

Returns:

a LZ4StreamInternal view of the struct pointed to by the dictCtx field.
dictCtx
()

public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the dictionary field.
dictionary
(int
the number of elements in the returned buffer
capacity
)

public int

Returns:

the value of the dictSize field.
dictSize
()

public IntBuffer

Returns:

a IntBuffer view of the hashTable field.
hashTable
()

public int

Returns:

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

public static int
ncurrentOffset(long struct)

Unsafe version of currentOffset.

public static LZ4StreamInternal
ndictCtx(long struct)

Unsafe version of dictCtx.

public static ByteBuffer
ndictionary(long struct, int capacity)

Unsafe version of dictionary.

public static int
ndictSize(long struct)

Unsafe version of dictSize.

public static IntBuffer
nhashTable(long struct)

Unsafe version of hashTable.

public static int
nhashTable(long struct, int index)

Unsafe version of hashTable.

public static int
ntableType(long struct)

Unsafe version of tableType.

public int
sizeof()

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

Returns sizeof(struct).
public int

Returns:

the value of the tableType field.
tableType
()

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.

CURRENTOFFSETback to summary
public static final int CURRENTOFFSET

The struct member offsets.

DICTCTXback to summary
public static final int DICTCTX

The struct member offsets.

DICTIONARYback to summary
public static final int DICTIONARY

The struct member offsets.

DICTSIZEback to summary
public static final int DICTSIZE

The struct member offsets.

HASHTABLEback to summary
public static final int HASHTABLE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TABLETYPEback to summary
public static final int TABLETYPE

The struct member offsets.

Constructor Detail

LZ4StreamInternalback to summary
protected LZ4StreamInternal(long address, ByteBuffer container)
LZ4StreamInternalback to summary
public LZ4StreamInternal(ByteBuffer container)

Creates a LZ4StreamInternal 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 LZ4StreamInternal 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 LZ4StreamInternal create(long address)

Returns a new LZ4StreamInternal instance for the specified memory address.

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

Create a LZ4StreamInternal.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static LZ4StreamInternal createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
currentOffsetback to summary
public int currentOffset()
Returns:int

the value of the currentOffset field.

Annotations
@NativeType:LZ4_u32
dictCtxback to summary
public LZ4StreamInternal dictCtx()
Returns:LZ4StreamInternal

a LZ4StreamInternal view of the struct pointed to by the dictCtx field.

Annotations
@NativeType:LZ4_stream_t_internal * const
dictionaryback to summary
public ByteBuffer dictionary(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the dictionary field.

Annotations
@NativeType:LZ4_byte const *
dictSizeback to summary
public int dictSize()
Returns:int

the value of the dictSize field.

Annotations
@NativeType:LZ4_u32
hashTableback to summary
public IntBuffer hashTable()
Returns:IntBuffer

a IntBuffer view of the hashTable field.

Annotations
@NativeType:LZ4_u32[LZ4_HASH_SIZE_U32]
hashTableback to summary
public int hashTable(int index)
Returns:int

the value at the specified index of the hashTable field.

Annotations
@NativeType:LZ4_u32
ncurrentOffsetback to summary
public static int ncurrentOffset(long struct)

Unsafe version of currentOffset.

ndictCtxback to summary
public static LZ4StreamInternal ndictCtx(long struct)

Unsafe version of dictCtx.

ndictionaryback to summary
public static ByteBuffer ndictionary(long struct, int capacity)

Unsafe version of dictionary.

ndictSizeback to summary
public static int ndictSize(long struct)

Unsafe version of dictSize.

nhashTableback to summary
public static IntBuffer nhashTable(long struct)

Unsafe version of hashTable.

nhashTableback to summary
public static int nhashTable(long struct, int index)

Unsafe version of hashTable.

ntableTypeback to summary
public static int ntableType(long struct)

Unsafe version of tableType.

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
tableTypeback to summary
public int tableType()
Returns:int

the value of the tableType field.

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

public Class LZ4StreamInternal.Buffer

extends StructBuffer<LZ4StreamInternal, LZ4StreamInternal.Buffer>
Class Inheritance

An array of LZ4StreamInternal structs.

Field Summary

Modifier and TypeField and Description
private static final LZ4StreamInternal

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new LZ4StreamInternal.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
public int

Returns:

the value of the currentOffset field.
currentOffset
()

public LZ4StreamInternal

Returns:

a LZ4StreamInternal view of the struct pointed to by the dictCtx field.
dictCtx
()

public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the dictionary field.
dictionary
(int
the number of elements in the returned buffer
capacity
)

public int

Returns:

the value of the dictSize field.
dictSize
()

protected LZ4StreamInternal
public IntBuffer

Returns:

a IntBuffer view of the hashTable field.
hashTable
()

public int

Returns:

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

protected LZ4StreamInternal.Buffer
public int

Returns:

the value of the tableType field.
tableType
()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final LZ4StreamInternal ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new LZ4StreamInternal.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 LZ4StreamInternal#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

currentOffsetback to summary
public int currentOffset()
Returns:int

the value of the currentOffset field.

Annotations
@NativeType:LZ4_u32
dictCtxback to summary
public LZ4StreamInternal dictCtx()
Returns:LZ4StreamInternal

a LZ4StreamInternal view of the struct pointed to by the dictCtx field.

Annotations
@NativeType:LZ4_stream_t_internal * const
dictionaryback to summary
public ByteBuffer dictionary(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the dictionary field.

Annotations
@NativeType:LZ4_byte const *
dictSizeback to summary
public int dictSize()
Returns:int

the value of the dictSize field.

Annotations
@NativeType:LZ4_u32
getElementFactoryback to summary
protected LZ4StreamInternal getElementFactory()

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

Annotations
@Override
hashTableback to summary
public IntBuffer hashTable()
Returns:IntBuffer

a IntBuffer view of the hashTable field.

Annotations
@NativeType:LZ4_u32[LZ4_HASH_SIZE_U32]
hashTableback to summary
public int hashTable(int index)
Returns:int

the value at the specified index of the hashTable field.

Annotations
@NativeType:LZ4_u32
selfback to summary
protected LZ4StreamInternal.Buffer self()

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

Annotations
@Override
tableTypeback to summary
public int tableType()
Returns:int

the value of the tableType field.

Annotations
@NativeType:LZ4_u32