com.github.flysium.io.yew.common.serialize.DataInput Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yew-serialization-api Show documentation
The newest version!
/*
 * Copyright 2018-2025 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 com.github.flysium.io.yew.common.serialize;

import java.io.IOException;

/**
 * Data input.
 *
 * @author Sven Augustus
 * @version 1.0
 */
public interface DataInput {

	/**
	 * Read boolean.
	 *
	 * @return boolean.
	 * @throws IOException if there is any io error.
	 */
	boolean readBoolean() throws IOException;

	/**
	 * Read byte.
	 *
	 * @return byte value.
	 * @throws IOException if there is any io error.
	 */
	byte readByte() throws IOException;

	/**
	 * Read short integer.
	 *
	 * @return short.
	 * @throws IOException if there is any io error.
	 */
	short readShort() throws IOException;

	/**
	 * Read integer.
	 *
	 * @return integer.
	 * @throws IOException if there is any io error.
	 */
	int readInt() throws IOException;

	/**
	 * Read long.
	 *
	 * @return long.
	 * @throws IOException if there is any io error.
	 */
	long readLong() throws IOException;

	/**
	 * Read float.
	 *
	 * @return float.
	 * @throws IOException if there is any io error.
	 */
	float readFloat() throws IOException;

	/**
	 * Read double.
	 *
	 * @return double.
	 * @throws IOException if there is any io error.
	 */
	double readDouble() throws IOException;

	/**
	 * Read UTF-8 string.
	 *
	 * @return string.
	 * @throws IOException if there is any io error.
	 */
	String readUTF() throws IOException;

	/**
	 * Read byte array.
	 *
	 * @return byte array.
	 * @throws IOException if there is any io error.
	 */
	byte[] readBytes() throws IOException;
}