org.apache.mina.util.byteaccess.IoRelativeWriter Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.mina.util.byteaccess;
import java.nio.ByteOrder;
import org.apache.mina.core.buffer.IoBuffer;
/**
* Provides relative read access to a sequence of bytes.
*
* @author Apache MINA Project
*/
public interface IoRelativeWriter {
/**
* @return the number of remaining bytes that can be read.
*/
int getRemaining();
/**
* @return if there are any remaining bytes that can be read.
*/
boolean hasRemaining();
/**
* Advances the writer by the given number of bytes.
*
* @param length The number of bytes to skip
*/
void skip(int length);
/**
* @return the bytes' order
*/
ByteOrder order();
/**
* Puts a byte and advances the reader.
*
* @param b The byte to put
*/
void put(byte b);
/**
* Puts enough bytes to fill the IoBuffer and advances the reader.
*
* @param bb The bytes to put
*/
void put(IoBuffer bb);
/**
* Puts a short and advances the reader.
*
* @param s The short to put
*/
void putShort(short s);
/**
* Puts an int and advances the reader.
*
* @param i The int to put
*/
void putInt(int i);
/**
* Puts a long and advances the reader.
*
* @param l The long to put
*/
void putLong(long l);
/**
* Puts a float and advances the reader.
*
* @param f The float to put
*/
void putFloat(float f);
/**
* Puts a double and advances the reader.
*
* @param d The double to put
*/
void putDouble(double d);
/**
* Puts a char and advances the reader.
*
* @param c The char to put
*/
void putChar(char c);
}