org.rapidoidx.buffer.Buf Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of rapidoid-x-buffer Show documentation
Rapidoid X Buffer
There is a newer version: 5.0.3
package org.rapidoidx.buffer;

import java.io.IOException;
import java.io.OutputStream;
import java.nio.ByteBuffer;
import java.nio.channels.ReadableByteChannel;
import java.nio.channels.WritableByteChannel;

import org.rapidoid.annotation.Authors;
import org.rapidoid.annotation.Since;
import org.rapidoid.wrap.LongWrap;
import org.rapidoidx.bytes.Bytes;
import org.rapidoidx.data.Range;
import org.rapidoidx.data.Ranges;

/*
 * #%L
 * rapidoid-x-buffer
 * %%
 * Copyright (C) 2014 - 2015 Nikolche Mihajlovski and contributors
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * 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 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 .
 * #L%
 */

@Authors("Nikolche Mihajlovski")
@Since("3.0.0")
public interface Buf {

	IncompleteReadException INCOMPLETE_READ = new IncompleteReadException();

	byte get(long position);

	void put(long position, byte value);

	void append(byte value);

	void put(long position, byte[] bytes, int offset, int length);

	long size();

	void append(ByteBuffer wrap);

	long append(ReadableByteChannel channel) throws IOException;

	long append(String s);

	void append(byte[] bytes);

	void append(byte[] bytes, int offset, int length);

	String data();

	long writeTo(WritableByteChannel channel) throws IOException;

	long writeTo(ByteBuffer buffer);

	void deleteBefore(long position);

	void deleteAfter(long position);

	void deleteLast(long count);

	int unitCount();

	int unitSize();

	void clear();

	String get(Range range);

	byte[] getBytes(Range range);

	long getN(Range range);

	boolean isSingle();

	ByteBuffer getSingle();

	ByteBuffer first();

	long putNumAsText(long position, long num, boolean forward);

	void get(Range range, byte[] dest, int offset);

	byte next();

	void back(long count);

	byte peek();

	boolean hasRemaining();

	long remaining();

	long position();

	long limit();

	void position(long position);

	void limit(long limit);

	void upto(byte value, Range range);

	ByteBuffer exposed();

	void scanUntil(byte value, Range range);

	void scanWhile(byte value, Range range);

	void skip(long count);

	ByteBuffer bufAt(int index);

	int bufCount();

	int bufferIndexOf(long position);

	int bufferOffsetOf(long position);

	OutputStream asOutputStream();

	String asText();

	Bytes bytes();

	void scanLn(Range range);

	void scanLnLn(Ranges ranges);

	void scanN(long count, Range range);

	String readLn();

	String readN(long count);

	byte[] readNbytes(int count);

	void scanTo(byte sep, Range range, boolean failOnLimit);

	long scanTo(byte sep1, byte sep2, Range range, boolean failOnLimit);

	void scanLnLn(Ranges ranges, LongWrap result, byte end1, byte end2);

	void setReadOnly(boolean readOnly);

	void checkpoint(long position);

	long checkpoint();

}