de.javagl.jgltf.model.io

Class Buffers

java.lang.Object

de.javagl.jgltf.model.io.Buffers

public class Buffers
extends java.lang.Object

Utility methods related to buffers

Method Summary

Modifier and Type	Method and Description
static void	bufferCopy(java.nio.ByteBuffer src, int srcPos, java.nio.ByteBuffer dst, int dstPos, int length) Perform a copy of the specified buffer range, analogously to System#arraycopy.
static java.nio.ByteBuffer	castToByteBuffer(java.nio.IntBuffer buffer) Convert the given input buffer into a direct byte buffer with native byte order, by casting all elements to byte.
static java.nio.ByteBuffer	castToShortByteBuffer(java.nio.IntBuffer buffer) Convert the given input buffer into a direct byte buffer with native byte order that contains the elements of the given input buffer, casted to short.
static java.nio.ByteBuffer	concat(java.util.Collection<? extends java.nio.ByteBuffer> byteBuffers) Create a direct byte buffer with native byte order whose contents is a concatenation of the given byte buffers.
static java.nio.ByteBuffer	copyOf(java.nio.ByteBuffer buffer, int newCapacity) Creates a copy of the given buffer, as a direct buffer with the same byte order, and the given capacity.
static java.nio.ByteBuffer	create(byte[] data) Creates a new, direct byte buffer that contains the given data, with little-endian byte order
static java.nio.ByteBuffer	create(byte[] data, int offset, int length) Creates a new, direct byte buffer that contains the specified range of the given data, with little-endian byte order
static java.nio.ByteBuffer	create(int size) Create a new direct byte buffer with the given size, and little-endian byte order.
static java.nio.ByteBuffer	createByteBufferFrom(java.nio.FloatBuffer buffer) Create a new direct byte buffer with native byte order that has the same contents as the given float buffer.
static java.nio.ByteBuffer	createByteBufferFrom(java.nio.IntBuffer buffer) Create a new direct byte buffer with native byte order that has the same contents as the given int buffer.
static java.nio.ByteBuffer	createByteBufferFrom(java.nio.ShortBuffer buffer) Create a new direct byte buffer with native byte order that has the same contents as the given short buffer.
static java.io.InputStream	createByteBufferInputStream(java.nio.ByteBuffer byteBuffer) Create an input stream from the given byte buffer, starting at its current position, up to its current limit.
static java.nio.ByteBuffer	createSlice(java.nio.ByteBuffer byteBuffer) Create a slice of the given byte buffer, using its current position and limit.
static java.nio.ByteBuffer	createSlice(java.nio.ByteBuffer byteBuffer, int position, int length) Create a slice of the given byte buffer, in the specified range.
static java.lang.String	readAsString(java.nio.ByteBuffer byteBuffer) Returns the contents of the given byte buffer as a string, using the platform's default charset, or null if the given buffer is null.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

readAsString

public static java.lang.String readAsString(java.nio.ByteBuffer byteBuffer)

Returns the contents of the given byte buffer as a string, using the platform's default charset, or null if the given buffer is null. The position and limit of the given buffer will be unaffected by this call.

Parameters:

byteBuffer - The byte buffer

Returns:

The data as a string

createSlice

public static java.nio.ByteBuffer createSlice(java.nio.ByteBuffer byteBuffer)

Create a slice of the given byte buffer, using its current position and limit. The returned slice will have the same byte order as the given buffer. If the given buffer is null, then null will be returned.

Parameters:

byteBuffer - The byte buffer

Returns:

The slice

createSlice

public static java.nio.ByteBuffer createSlice(java.nio.ByteBuffer byteBuffer,
                                              int position,
                                              int length)

Create a slice of the given byte buffer, in the specified range. The returned buffer will have the same byte order as the given buffer. If the given buffer is null, then null will be returned.

Parameters:

byteBuffer - The byte buffer

position - The position where the slice should start

length - The length of the slice

Returns:

The slice

Throws:

java.lang.IllegalArgumentException - If the range that is specified by the position and length are not valid for the given buffer

create

public static java.nio.ByteBuffer create(byte[] data)

Creates a new, direct byte buffer that contains the given data, with little-endian byte order

Parameters:

data - The data

Returns:

The byte buffer

create

public static java.nio.ByteBuffer create(byte[] data,
                                         int offset,
                                         int length)

Creates a new, direct byte buffer that contains the specified range of the given data, with little-endian byte order

Parameters:

data - The data

offset - The offset in the data array

length - The length of the range

Returns:

The byte buffer

create

public static java.nio.ByteBuffer create(int size)

Create a new direct byte buffer with the given size, and little-endian byte order.

Parameters:

size - The size of the buffer

Returns:

The byte buffer

Throws:

java.lang.IllegalArgumentException - If the given size is negative

createByteBufferInputStream

public static java.io.InputStream createByteBufferInputStream(java.nio.ByteBuffer byteBuffer)

Create an input stream from the given byte buffer, starting at its current position, up to its current limit. Reading the returned stream will advance the position of the buffer. If this is not desired, a slice of the buffer may be passed to this method.

Parameters:

byteBuffer - The buffer

Returns:

The input stream

concat

public static java.nio.ByteBuffer concat(java.util.Collection<? extends java.nio.ByteBuffer> byteBuffers)

Create a direct byte buffer with native byte order whose contents is a concatenation of the given byte buffers. If the given collection is null or empty, then a 0-byte buffer will be created. The given collection may not contain null elements.

Parameters:

byteBuffers - The input byte buffers

Returns:

The concatenated byte buffer

createByteBufferFrom

public static java.nio.ByteBuffer createByteBufferFrom(java.nio.FloatBuffer buffer)

Create a new direct byte buffer with native byte order that has the same contents as the given float buffer.

Parameters:

buffer - The input buffer

Returns:

The new byte buffer

createByteBufferFrom

public static java.nio.ByteBuffer createByteBufferFrom(java.nio.IntBuffer buffer)

Create a new direct byte buffer with native byte order that has the same contents as the given int buffer.

Parameters:

buffer - The input buffer

Returns:

The new byte buffer

createByteBufferFrom

public static java.nio.ByteBuffer createByteBufferFrom(java.nio.ShortBuffer buffer)

Create a new direct byte buffer with native byte order that has the same contents as the given short buffer.

Parameters:

buffer - The input buffer

Returns:

The new byte buffer

castToByteBuffer

public static java.nio.ByteBuffer castToByteBuffer(java.nio.IntBuffer buffer)

Convert the given input buffer into a direct byte buffer with native byte order, by casting all elements to byte.

Parameters:

buffer - The input buffer

Returns:

The byte buffer

castToShortByteBuffer

public static java.nio.ByteBuffer castToShortByteBuffer(java.nio.IntBuffer buffer)

Convert the given input buffer into a direct byte buffer with native byte order that contains the elements of the given input buffer, casted to short.

Parameters:

buffer - The input buffer

Returns:

The short buffer

copyOf

public static java.nio.ByteBuffer copyOf(java.nio.ByteBuffer buffer,
                                         int newCapacity)

Creates a copy of the given buffer, as a direct buffer with the same byte order, and the given capacity. If the given capacity is smaller than that of the given buffer, the copy will be truncated. If it is larger, the additional bytes will be initialized to zero.

Parameters:

buffer - The input buffer

newCapacity - The new capacity

Returns:

The copy

bufferCopy

public static void bufferCopy(java.nio.ByteBuffer src,
                              int srcPos,
                              java.nio.ByteBuffer dst,
                              int dstPos,
                              int length)

Perform a copy of the specified buffer range, analogously to System#arraycopy.

Parameters:

src - The source buffer

srcPos - The source position

dst - The destination buffer

dstPos - The destination position

length - The length

Throws:

java.lang.IndexOutOfBoundsException - If the indices are invalid.