java.io

Класс FilterInputStream

java.lang. Объект

java.io. InputStream

java.io. FilterInputStream

Все Реализованные Интерфейсы:

Closeable, AutoCloseable

Прямые Известные Подклассы:

BufferedInputStream, CheckedInputStream, CipherInputStream, DataInputStream, DeflaterInputStream, DigestInputStream, InflaterInputStream, LineNumberInputStream, ProgressMonitorInputStream, PushbackInputStream

public class FilterInputStream
extends InputStream

A FilterInputStream содержит некоторый другой входной поток, который это использует в качестве его основного источника данных, возможно преобразовывая данные по пути или обеспечивая дополнительную функциональность. Класс FilterInputStream непосредственно просто переопределения все методы InputStream с версиями, которые передают все запросы к содержавшему входному потоку. Подклассы FilterInputStream май далее переопределяет некоторые из этих методов и может также обеспечить дополнительные методы и поля.

С тех пор:

JDK1.0

Полевая Сводка

Поля

Модификатор и Тип	Поле и Описание
protected InputStream	в Входной поток, который будет фильтроваться.

Сводка конструктора

Конструкторы

Модификатор	Конструктор и Описание
protected	FilterInputStream(InputStream in) Создает a FilterInputStream присваивая параметр in к полю this.in чтобы помнить это для более позднего использования.

Сводка метода

Методы

Модификатор и Тип	Метод и Описание
int	available() Возвращает оценку числа байтов, которые могут быть считаны (или перескочиться) от этого входного потока, не блокируя следующей вызывающей стороной метода для этого входного потока.
void	close() Завершения этот входной поток и выпуски любые системные ресурсы связались с потоком.
void	mark(int readlimit) Отмечает текущую позицию в этом входном потоке.
boolean	markSupported() Тесты, если этот входной поток поддерживает mark и reset методы.
int	read() Читает следующий байт данных от этого входного потока.
int	read(byte[] b) Чтения до byte.length байты данных от этого входного потока в массив байтов.
int	read(byte[] b, int off, int len) Чтения до len байты данных от этого входного потока в массив байтов.
void	reset() Репозиции этот поток к позиции в это время mark метод был последним, обращался к этому входному потоку.
long	skip(long n) Перескакивает и отбрасывает n байты данных от входного потока.

Методы java.lang унаследованный от класса. Объект

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

Полевая Деталь

в

protected volatile InputStream in

Входной поток, который будет фильтроваться.

Деталь конструктора

FilterInputStream

protected FilterInputStream(InputStream in)

Создает a FilterInputStream присваивая параметр in к полю this.in чтобы помнить это для более позднего использования.

Параметры:

in - базовый входной поток, или null если этот экземпляр должен быть создан без базового потока.

Деталь метода

читать

public int read()
         throws IOException

Читает следующий байт данных от этого входного потока. Байт значения возвращается как int в диапазоне 0 к 255. Если никакой байт не доступен, потому что конец потока был достигнут, значение -1 возвращается. Этот метод блоки до входных данных доступен, конец потока обнаруживается, или исключение выдается.

Этот метод просто выполняет in.read() и возвращает результат.

Определенный:

read в классе InputStream

Возвраты:

следующий байт данных, или -1 если конец потока достигается.

Броски:

IOException - если ошибка ввода-вывода происходит.

См. Также:

in

читать

public int read(byte[] b)
         throws IOException

Чтения до byte.length байты данных от этого входного потока в массив байтов. Этот метод блоки до некоторого ввода доступен.

Этот метод просто выполняет вызов read(b, 0, b.length) и возвращает результат. Важно, чтобы это не сделало in.read(b) вместо этого; определенные подклассы FilterInputStream зависьте от стратегии реализации, фактически используемой.

Переопределения:

read в классе InputStream

Параметры:

b - буфер, в который читаются данные.

Возвраты:

общее количество чтения байтов в буфер, или -1 если нет больше данных, потому что конец потока был достигнут.

Броски:

IOException - если ошибка ввода-вывода происходит.

См. Также:

read(byte[], int, int)

читать

public int read(byte[] b,
       int off,
       int len)
         throws IOException

Чтения до len байты данных от этого входного потока в массив байтов. Если len не нуль, блоки метода, пока некоторый ввод не доступен; иначе, никакие байты не читаются и 0 возвращается.

Этот метод просто выполняет in.read(b, off, len) и возвращает результат.

Переопределения:

read в классе InputStream

Параметры:

b - буфер, в который читаются данные.

off - запуск смещается в целевом массиве b

len - максимальное количество байтов читало.

Возвраты:

общее количество чтения байтов в буфер, или -1 если нет больше данных, потому что конец потока был достигнут.

Броски:

NullPointerException - Если b null.

IndexOutOfBoundsException - Если off отрицательно, len отрицательно, или len больше чем b.length - off

IOException - если ошибка ввода-вывода происходит.

См. Также:

in

пропустить

public long skip(long n)
          throws IOException

Перескакивает и отбрасывает n байты данных от входного потока. skip метод, для множества причин, может закончить тем, что перескочил через некоторое меньшее число байтов, возможно 0. Фактическое число пропущенных байтов возвращается.

Этот метод просто выполняет in.skip(n).

Переопределения:

skip в классе InputStream

Параметры:

n - число байтов, которые будут пропущены.

Возвраты:

фактическое число байтов пропускается.

Броски:

IOException - если поток не поддерживает, ищут, или если некоторая другая ошибка ввода-вывода происходит.

доступный

public int available()
              throws IOException

Возвращает оценку числа байтов, которые могут быть считаны (или перескочиться) от этого входного потока, не блокируя следующей вызывающей стороной метода для этого входного потока. Следующая вызывающая сторона могла бы быть тем же самым потоком или другим потоком. Единственное чтение или пропуск этого много байтов не будут блокировать, но могут считать или пропустить меньше байтов.

Этот метод возвращает результат in.available ().

Переопределения:

available в классе InputStream

Возвраты:

оценка числа байтов, которые могут быть считаны (или перескочиться) от этого входного потока без блокирования.

Броски:

IOException - если ошибка ввода-вывода происходит.

близко

public void close()
           throws IOException

Завершения этот входной поток и выпуски любые системные ресурсы связались с потоком. Этот метод просто выполняет in.close().

Определенный:

close в интерфейсе Closeable

Определенный:

close в интерфейсе AutoCloseable

Переопределения:

close в классе InputStream

Броски:

IOException - если ошибка ввода-вывода происходит.

См. Также:

in

метка

public void mark(int readlimit)

Отмечает текущую позицию в этом входном потоке. Последующий звонок reset репозиции метода этот поток в последней отмеченной позиции так, чтобы последующие чтения, перечитанные те же самые байты.

readlimit параметр говорит этому входному потоку признавать, что много байтов, которые будут считаны перед позицией метки, лишаются законной силы.

Этот метод просто выполняет in.mark(readlimit).

Переопределения:

mark в классе InputStream

Параметры:

readlimit - максимальный предел байтов, которые могут быть считаны перед позицией метки, становится недопустимым.

См. Также:

in, reset()

сброс

public void reset()
           throws IOException

Репозиции этот поток к позиции в это время mark метод был последним, обращался к этому входному потоку.

Этот метод просто выполняет in.reset().

Потоковые метки предназначаются, чтобы использоваться в ситуациях, где Вы должны читать вперед немного, чтобы видеть то, что находится в потоке. Часто это наиболее легко делается, вызывая некоторый общий синтаксический анализатор. Если поток имеет тип, обработанный синтаксическим анализом, это только двигается с пыхтением вперед счастливо. Если поток не имеет того типа, синтаксический анализатор должен бросить исключение, когда это перестало работать. Если это происходит в пределах readlimit байтов, это позволяет внешнему коду сбрасывать поток и пробовать другой синтаксический анализатор.

Переопределения:

reset в классе InputStream

Броски:

IOException - если поток не был отмечен или если метка была лишена законной силы.

См. Также:

in, mark(int)

markSupported

public boolean markSupported()

Тесты, если этот входной поток поддерживает mark и reset методы. Этот метод просто выполняет in.markSupported().

Переопределения:

markSupported в классе InputStream

Возвраты:

true если этот потоковый тип поддерживает mark и reset метод; false иначе.

См. Также:

in, InputStream.mark(int), InputStream.reset()