littleendianaccessor.java.svn-base

冒险岛私服Java版服务端(Odinms)源代码。学习JAVA开发的朋友

/*
	This file is part of the OdinMS Maple Story Server
    Copyright (C) 2008 Patrick Huy <[e-mail]> 
                       Matthias Butz <[e-mail]>
                       Jan Christian Meyer <[e-mail]>

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License version 3
    as published by the Free Software Foundation. You may not use, modify
    or distribute this program under any other version of the
    GNU Affero General Public License.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

package net.sf.odinms.tools.data.input;

/**
 * Provides an abstract interface for a little-endian stream of bytes.
 * 
 * @author Frz
 * @version 1.0
 * @since Revision 323
 */
public interface LittleEndianAccessor {
	/**
	 * Reads a byte.
	 * 
	 * @return The byte read.
	 */
	byte readByte();
	/**
	 * Reads a character.
	 * 
	 * @return The character read.
	 */
	char readChar();
	/**
	 * Reads a short integer.
	 * 
	 * @return The short integer read.
	 */
	short readShort();
	/**
	 * Reads a integer.
	 * 
	 * @return The integer read.
	 */
	int readInt();
	/**
	 * Reads a long integer.
	 * 
	 * @return The long integer read.
	 */
	long readLong();
	/**
	 * Skips ahead <code>num</code> bytes.
	 * 
	 * @param num Number of bytes to skip ahead.
	 */
	void skip (int num);
	/**
	 * Reads a number of bytes.
	 * 
	 * @param num The number of bytes to read.
	 * @return The bytes read.
	 */
	byte []read(int num);
	
	/**
	 * Reads a floating point integer.
	 * 
	 * @return The floating point integer read.
	 */
	float readFloat();
	/**
	 * Reads a double-precision integer.
	 * 
	 * @return The double-precision integer read.
	 */
	double readDouble();
	
	/**
	 * Reads an ASCII string.
	 * 
	 * @return The string read.
	 */
	String readAsciiString(int n);
	/**
	 * Reads a null-terminated ASCII string.
	 * 
	 * @return The string read.
	 */
	String readNullTerminatedAsciiString();
	/**
	 * Reads a MapleStory convention lengthed ASCII string.
	 * 
	 * @return The string read.
	 */
	String readMapleAsciiString();
	
	/**
	 * Gets the number of bytes read so far.
	 * 
	 * @return The number of bytes read as an long integer.
	 */
	long getBytesRead();
	/**
	 * Gets the number of bytes left for reading.
	 * 
	 * @return The number of bytes left for reading as an long integer.
	 */
	long available();
}