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

public Class LZ4StreamDecodeInternal

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

Layout


struct LZ4_streamDecode_t_internal {
    LZ4_byte const * externalDict;
    LZ4_byte const * prefixEnd;
    size_t extDictSize;
    size_t prefixSize;
}

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
EXTDICTSIZE

The struct member offsets.

public static final int
EXTERNALDICT

The struct member offsets.

public static final int
PREFIXEND

The struct member offsets.

public static final int
PREFIXSIZE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
LZ4StreamDecodeInternal(ByteBuffer container)

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

Method Summary

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

Returns a new LZ4StreamDecodeInternal instance for the specified memory address.

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

Create a LZ4StreamDecodeInternal.Buffer instance at the specified memory.

public static LZ4StreamDecodeInternal
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long

Returns:

the value of the extDictSize field.
extDictSize
()

public ByteBuffer

Returns:

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

public static long
nextDictSize(long struct)

Unsafe version of extDictSize.

public static ByteBuffer
nexternalDict(long struct, int capacity)

Unsafe version of externalDict.

public static ByteBuffer
nprefixEnd(long struct, int capacity)

Unsafe version of prefixEnd.

public static long
nprefixSize(long struct)

Unsafe version of prefixSize.

public ByteBuffer

Returns:

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

public long

Returns:

the value of the prefixSize field.
prefixSize
()

public int
sizeof()

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

Returns sizeof(struct).
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.

EXTDICTSIZEback to summary
public static final int EXTDICTSIZE

The struct member offsets.

EXTERNALDICTback to summary
public static final int EXTERNALDICT

The struct member offsets.

PREFIXENDback to summary
public static final int PREFIXEND

The struct member offsets.

PREFIXSIZEback to summary
public static final int PREFIXSIZE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

LZ4StreamDecodeInternalback to summary
protected LZ4StreamDecodeInternal(long address, ByteBuffer container)
LZ4StreamDecodeInternalback to summary
public LZ4StreamDecodeInternal(ByteBuffer container)

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

Returns a new LZ4StreamDecodeInternal instance for the specified memory address.

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

Create a LZ4StreamDecodeInternal.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static LZ4StreamDecodeInternal createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
extDictSizeback to summary
public long extDictSize()
Returns:long

the value of the extDictSize field.

Annotations
@NativeType:size_t
externalDictback to summary
public ByteBuffer externalDict(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 externalDict field.

Annotations
@NativeType:LZ4_byte const *
nextDictSizeback to summary
public static long nextDictSize(long struct)

Unsafe version of extDictSize.

nexternalDictback to summary
public static ByteBuffer nexternalDict(long struct, int capacity)

Unsafe version of externalDict.

nprefixEndback to summary
public static ByteBuffer nprefixEnd(long struct, int capacity)

Unsafe version of prefixEnd.

nprefixSizeback to summary
public static long nprefixSize(long struct)

Unsafe version of prefixSize.

prefixEndback to summary
public ByteBuffer prefixEnd(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 prefixEnd field.

Annotations
@NativeType:LZ4_byte const *
prefixSizeback to summary
public long prefixSize()
Returns:long

the value of the prefixSize field.

Annotations
@NativeType:size_t
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
org.lwjgl.util.lz4 back to summary

public Class LZ4StreamDecodeInternal.Buffer

extends StructBuffer<LZ4StreamDecodeInternal, LZ4StreamDecodeInternal.Buffer>
Class Inheritance

An array of LZ4StreamDecodeInternal structs.

Field Summary

Modifier and TypeField and Description
private static final LZ4StreamDecodeInternal

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new LZ4StreamDecodeInternal.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 long

Returns:

the value of the extDictSize field.
extDictSize
()

public ByteBuffer

Returns:

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

protected LZ4StreamDecodeInternal
public ByteBuffer

Returns:

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

public long

Returns:

the value of the prefixSize field.
prefixSize
()

protected LZ4StreamDecodeInternal.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final LZ4StreamDecodeInternal ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

extDictSizeback to summary
public long extDictSize()
Returns:long

the value of the extDictSize field.

Annotations
@NativeType:size_t
externalDictback to summary
public ByteBuffer externalDict(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 externalDict field.

Annotations
@NativeType:LZ4_byte const *
getElementFactoryback to summary
protected LZ4StreamDecodeInternal getElementFactory()

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

Annotations
@Override
prefixEndback to summary
public ByteBuffer prefixEnd(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 prefixEnd field.

Annotations
@NativeType:LZ4_byte const *
prefixSizeback to summary
public long prefixSize()
Returns:long

the value of the prefixSize field.

Annotations
@NativeType:size_t
selfback to summary
protected LZ4StreamDecodeInternal.Buffer self()

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

Annotations
@Override