io.atomix.catalyst.buffer.BytesInput Maven / Gradle / Ivy
/*
* Copyright 2015 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.atomix.catalyst.buffer;
/**
* Readable bytes.
*
* This interface exposes methods for reading bytes from specific positions in a byte array.
*
* @author Jordan Halterman
*/
public interface BytesInput> {
/**
* Reads bytes into the given byte array starting at the given offset up to the given length.
*
* @param offset The offset from which to start reading bytes.
* @param dst The byte array into which to read bytes.
* @param dstOffset The offset at which to write bytes into the given buffer.
* @param length The total number of bytes to read.
* @return The buffer.
*/
T read(long offset, Bytes dst, long dstOffset, long length);
/**
* Reads bytes into the given byte array starting at the given offset up to the given length.
*
* @param offset The offset from which to start reading bytes.
* @param dst The byte array into which to read bytes.
* @param dstOffset The offset at which to write bytes into the given buffer
* @param length The total number of bytes to read.
* @return The buffer.
*/
T read(long offset, byte[] dst, long dstOffset, long length);
/**
* Reads a byte from the buffer at the given offset.
*
* @param offset The offset at which to read the byte.
* @return The read byte.
*/
int readByte(long offset);
/**
* Reads an unsigned byte from the buffer at the given offset.
*
* @param offset The offset at which to read the byte.
* @return The read unsigned byte.
*/
int readUnsignedByte(long offset);
/**
* Reads a 16-bit character from the buffer at the given offset.
*
* @param offset The offset at which to read the character.
* @return The read character.
*/
char readChar(long offset);
/**
* Reads a 16-bit signed integer from the buffer at the given offset.
*
* @param offset The offset at which to read the short.
* @return The read short.
*/
short readShort(long offset);
/**
* Reads a 16-bit unsigned integer from the buffer at the given offset.
*
* @param offset The offset at which to read the short.
* @return The read short.
*/
int readUnsignedShort(long offset);
/**
* Reads a 24-bit signed integer from the buffer at the given offset.
*
* @param offset The offset at which to read the integer.
* @return The read medium.
*/
int readMedium(long offset);
/**
* Reads a 24-bin unsigned integer from the buffer at the given offset.
*
* @param offset The offset at which to read the integer.
* @return The read medium.
*/
int readUnsignedMedium(long offset);
/**
* Reads a 32-bit signed integer from the buffer at the given offset.
*
* @param offset The offset at which to read the integer.
* @return The read integer.
*/
int readInt(long offset);
/**
* Reads a 32-bit unsigned integer from the buffer at the given offset.
*
* @param offset The offset at which to read the integer.
* @return The read integer.
*/
long readUnsignedInt(long offset);
/**
* Reads a 64-bit signed integer from the buffer at the given offset.
*
* @param offset The offset at which to read the long.
* @return The read long.
*/
long readLong(long offset);
/**
* Reads a single-precision 32-bit floating point number from the buffer at the given offset.
*
* @param offset The offset at which to read the float.
* @return The read float.
*/
float readFloat(long offset);
/**
* Reads a double-precision 64-bit floating point number from the buffer at the given offset.
*
* @param offset The offset at which to read the double.
* @return The read double.
*/
double readDouble(long offset);
/**
* Reads a 1 byte boolean from the buffer at the given offset.
*
* @param offset The offset at which to read the boolean.
* @return The read boolean.
*/
boolean readBoolean(long offset);
/**
* Reads a string from the buffer at the given offset.
*
* @param offset The offset at which to read the string.
* @return The read string.
*/
String readString(long offset);
/**
* Reads a UTF-8 string from the buffer at the given offset.
*
* @param offset The offset at which to read the string.
* @return The read string.
*/
String readUTF8(long offset);
}