com.javanut.pronghorn.pipe.TextReader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pronghorn-pipes Show documentation

Ring buffer based queuing utility for applications that require high performance and/or a small footprint. Well suited for embedded and stream based processing.

There is a newer version: 1.1.27

Show newest version

package com.javanut.pronghorn.pipe;

public interface TextReader {

	/**
	 * Reads bytes from ChannelReader depending on leading short for length
	 * assuming bytes are UTF-8 encoded passes them to target
	 * @param target receiver of converted bytes
     * @param  type of appendable target
	 * @return target with UTF bytes
	 */
	public  A readUTF(A target);
	
	/**
	 * Reads UTF bytes from ChannelReader
	 * @return String of UTF bytes
	 */
	public String readUTF();
	
	/**
	 * Reads data from ChannelReader and checks if the UTF text matches input text
	 * @param equalText text used for comparison
	 * @return boolean saying if data from ChannelReader matches equalText
	 */
	public boolean equalUTF(byte[] equalText);
	
	
}