Class NullByteInput

java.lang.Object

cool.scx.io.NullByteInput

All Implemented Interfaces:

ByteInput, AutoCloseable

public final class NullByteInput
extends Object
implements ByteInput

NullByteInput

Version:

0.0.1

Author:

scx567888

Constructor Summary

Constructors

Constructor	Description
NullByteInput()

Method Summary

Modifier and Type	Method	Description
void	close()	关闭这个流, 此方法应该是幂等的.
ByteMatchResult	indexOf(ByteIndexer indexer, long maxLength)	在最多 maxLength 个字节中查找匹配 (或直到 EOF).
boolean	isClosed()	检测当前流是否关闭
ByteInputMark	mark()	在当前读取位置创建一个标记对象.
byte	peek()	查看字节, 行为参考 ByteInput.read()
<X extends Throwable> void	peek(ByteConsumer<X> byteConsumer, long maxLength)	查看字节, 行为参考 ByteInput.read(ByteConsumer, long)
<X extends Throwable> void	peekFully(ByteConsumer<X> byteConsumer, long length)	查看字节, 行为参考 ByteInput.readFully(ByteConsumer, long)
<X extends Throwable> void	peekUpTo(ByteConsumer<X> byteConsumer, long length)	查看字节, 行为参考 ByteInput.readUpTo(ByteConsumer, long)
byte	read()	读取单个字节
<X extends Throwable> void	read(ByteConsumer<X> byteConsumer, long maxLength)	最多读取 maxLength 个字节, 可能少于 maxLength (即使尚未遇到 EOF, 如底层缓冲区不足)
<X extends Throwable> void	readFully(ByteConsumer<X> byteConsumer, long length)	恰好读取 length 个字节
<X extends Throwable> void	readUpTo(ByteConsumer<X> byteConsumer, long length)	尽量读取 length 个字节, 可能少于 length (仅在 EOF 时发生)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ByteInput

indexOf, indexOf, indexOf, indexOf, indexOf, peek, peekAll, peekAll, peekFully, peekUntil, peekUntil, peekUntil, peekUntil, peekUntil, peekUntil, peekUpTo, read, readAll, readAll, readFully, readUntil, readUntil, readUntil, readUntil, readUntil, readUntil, readUpTo, skip, skipAll, skipFully, skipUpTo

Constructor Details

NullByteInput

public NullByteInput()

Method Details

read

public byte read()
          throws ScxIOException,
AlreadyClosedException,
NoMoreDataException

Description copied from interface: ByteInput

读取单个字节

• 如果 当前没有数据可读 (立即遇到 EOF), 则会抛出 NoMoreDataException

Specified by:

read in interface ByteInput

Throws:

ScxIOException

AlreadyClosedException

NoMoreDataException

read

public <X extends Throwable> void read(ByteConsumer<X> byteConsumer,
 long maxLength)
                                throws X,
ScxIOException,
AlreadyClosedException,
NoMoreDataException

Description copied from interface: ByteInput

最多读取 maxLength 个字节, 可能少于 maxLength (即使尚未遇到 EOF, 如底层缓冲区不足)

• 如果 maxLength = 0, 立即返回 (不抛出异常, 即使在 EOF 状态)
• 如果 maxLength > 0, 至少读取 1 个字节.
  • 如果 数据不足 (读取过程中遇到 EOF), 则停止读取
  • 如果 当前没有数据可读 (立即遇到 EOF), 则会抛出 NoMoreDataException

Specified by:

read in interface ByteInput

Throws:

X

ScxIOException

AlreadyClosedException

NoMoreDataException

readUpTo

public <X extends Throwable> void readUpTo(ByteConsumer<X> byteConsumer,
 long length)
                                    throws X,
ScxIOException,
AlreadyClosedException,
NoMoreDataException

Description copied from interface: ByteInput

尽量读取 length 个字节, 可能少于 length (仅在 EOF 时发生)

• 如果 length = 0, 立即返回 (不抛出异常, 即使在 EOF 状态)
• 如果 length > 0, 至少读取 1 个字节.
  • 如果 数据不足 (读取过程中遇到 EOF), 则停止读取
  • 如果 当前没有数据可读 (立即遇到 EOF), 则会抛出 NoMoreDataException

Specified by:

readUpTo in interface ByteInput

Throws:

X

ScxIOException

AlreadyClosedException

NoMoreDataException

readFully

public <X extends Throwable> void readFully(ByteConsumer<X> byteConsumer,
 long length)
                                     throws X,
ScxIOException,
AlreadyClosedException,
NoMoreDataException

Description copied from interface: ByteInput

恰好读取 length 个字节

• 如果 length = 0, 立即返回且不抛出异常 (即使在 EOF 状态)
• 如果 length > 0. 一定读取 length 个字节.
  • 如果 数据不足 (读取过程中遇到 EOF), 则会抛出 NoMoreDataException
  • 如果 当前没有数据可读 (立即遇到 EOF), 则会抛出 NoMoreDataException

Specified by:

readFully in interface ByteInput

Throws:

X

ScxIOException

AlreadyClosedException

NoMoreDataException

peek

public byte peek()
          throws ScxIOException,
AlreadyClosedException,
NoMoreDataException

Description copied from interface: ByteInput

查看字节, 行为参考 ByteInput.read()

Specified by:

peek in interface ByteInput

Throws:

ScxIOException

AlreadyClosedException

NoMoreDataException

peek

public <X extends Throwable> void peek(ByteConsumer<X> byteConsumer,
 long maxLength)
                                throws X,
ScxIOException,
AlreadyClosedException,
NoMoreDataException

Description copied from interface: ByteInput

查看字节, 行为参考 ByteInput.read(ByteConsumer, long)

Specified by:

peek in interface ByteInput

Throws:

X

ScxIOException

AlreadyClosedException

NoMoreDataException

peekUpTo

public <X extends Throwable> void peekUpTo(ByteConsumer<X> byteConsumer,
 long length)
                                    throws X,
ScxIOException,
AlreadyClosedException,
NoMoreDataException

Description copied from interface: ByteInput

查看字节, 行为参考 ByteInput.readUpTo(ByteConsumer, long)

Specified by:

peekUpTo in interface ByteInput

Throws:

X

ScxIOException

AlreadyClosedException

NoMoreDataException

peekFully

public <X extends Throwable> void peekFully(ByteConsumer<X> byteConsumer,
 long length)
                                     throws X,
ScxIOException,
AlreadyClosedException,
NoMoreDataException

Description copied from interface: ByteInput

查看字节, 行为参考 ByteInput.readFully(ByteConsumer, long)

Specified by:

peekFully in interface ByteInput

Throws:

X

ScxIOException

AlreadyClosedException

NoMoreDataException

indexOf

public ByteMatchResult indexOf(ByteIndexer indexer,
 long maxLength)
                        throws NoMatchFoundException,
ScxIOException,
AlreadyClosedException,
NoMoreDataException

Description copied from interface: ByteInput

在最多 maxLength 个字节中查找匹配 (或直到 EOF).

• 如果 indexer 是 空匹配模式. (意味着没有消费数据的能力和意义)
  • 在任意情况下都返回 0. (恒为 0)
• 如果 indexer 不是 空匹配模式.
  • 如果 maxLength = 0, 抛 NoMatchFoundException (恒 NoMatch, 因为这是不可能完成的任务).
  • 如果 maxLength > 0. (正常逻辑)
    • 如果在边界达成条件内仍未匹配到 (如达到 maxLength限制 或 读取过程中遇到 EOF) 抛出 NoMatchFoundException.
    • 如果 当前没有数据可读 (立即遇到 EOF), 则会抛出 NoMoreDataException.

Specified by:

indexOf in interface ByteInput

Throws:

NoMatchFoundException

ScxIOException

AlreadyClosedException

NoMoreDataException

mark

public ByteInputMark mark()
                   throws AlreadyClosedException

Description copied from interface: ByteInput

在当前读取位置创建一个标记对象.

Specified by:

mark in interface ByteInput

Throws:

AlreadyClosedException

isClosed

public boolean isClosed()

Description copied from interface: ByteInput

检测当前流是否关闭

Specified by:

isClosed in interface ByteInput

close

public void close()
           throws ScxIOException

Description copied from interface: ByteInput

关闭这个流, 此方法应该是幂等的.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ByteInput

Throws:

ScxIOException