Класс InputStream

public InputStream()

Конструктор для вызова подклассами.

public static InputStream nullInputStream()

Возвращает новый InputStream, который не считывает байты. Возвращённый поток изначально открыт. Поток закрывается вызовом метода close(). Последующие вызовы close() не оказывают никакого эффекта.

Пока поток открыт, методы available(), read(), read(byte[]), read(byte[], int, int), readAllBytes(), readNBytes(byte[], int, int), readNBytes(int), skip(long), skipNBytes(long) и transferTo() ведут себя так, как если бы был достигнут конец потока. После закрытия потока все эти методы выбрасывают IOException.

Метод markSupported() возвращает false. Метод mark() ничего не делает, а метод reset() выбрасывает IOException.

public abstract int read() throws IOException

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

public int read(byte[] b) throws IOException

Считывает некоторое количество байтов из входного потока и сохраняет их в массиве буфера b. Фактически считанное количество байтов возвращается в виде целого числа. Этот метод блокирует выполнение до тех пор, пока не станут доступны входные данные, не будет обнаружен конец файла или не будет выброшено исключение.

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

Первый считанный байт сохраняется в элементе b[0], следующий — в b[1] и так далее. Количество считанных байтов не превышает длину b. Пусть k — фактически считанное количество байтов; эти байты будут сохранены в элементах от b[0] до b[k-1], а элементы от b[k] до b[b.length-1] останутся без изменений.

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

Считывает до len байтов данных из входного потока в массив байтов. Предпринимается попытка считать до len байтов, однако фактически может быть считано меньшее количество. Фактически считанное количество байтов возвращается в виде целого числа.

Этот метод блокирует выполнение до тех пор, пока не станут доступны входные данные, не будет обнаружен конец файла или не будет выброшено исключение.

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

Первый считанный байт сохраняется в элементе b[off], следующий — в b[off+1] и так далее. Количество считанных байтов не превышает len. Пусть k — фактически считанное количество байтов; эти байты будут сохранены в элементах от b[off] до b[off+k-1], а элементы от b[off+k] до b[off+len-1] останутся без изменений.

В любом случае элементы от b[0] до b[off-1] и элементы от b[off+len] до b[b.length-1] остаются без изменений.

public byte[] readAllBytes() throws IOException

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

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

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

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

Если при считывании из входного потока возникает ошибка ввода-вывода, она может произойти после считывания части, но не всех байтов. Следовательно, входной поток может не достичь конца и может оказаться в несогласованном состоянии. Настоятельно рекомендуется незамедлительно закрыть поток при возникновении ошибки ввода-вывода.

public byte[] readNBytes(int len) throws IOException

Считывает из входного потока указанное количество байтов. Этот метод блокирует выполнение до тех пор, пока не будет считано запрошенное количество байтов, не будет обнаружен конец потока или не будет выброшено исключение. Этот метод не закрывает входной поток.

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

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

Обратите внимание, что этот метод предназначен для простых случаев, когда удобно считать указанное количество байтов в массив байтов. Общий объём памяти, выделяемой этим методом, пропорционален количеству байтов, считанных из потока, и ограничен значением len. Поэтому метод можно безопасно вызывать с очень большими значениями len при наличии достаточного объёма памяти.

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

Если при считывании из входного потока возникает ошибка ввода-вывода, она может произойти после считывания части, но не всех байтов. Следовательно, входной поток может не достичь конца и может оказаться в несогласованном состоянии. Настоятельно рекомендуется незамедлительно закрыть поток при возникновении ошибки ввода-вывода.

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

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

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

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

Первый считанный байт сохраняется в элементе b[off], следующий — в b[off+1] и так далее. Количество считанных байтов не превышает len. Пусть k — фактически считанное количество байтов; эти байты будут сохранены в элементах от b[off] до b[off+k-1], а элементы от b[off+k ] до b[off+len-1] останутся без изменений.

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

Если при считывании из входного потока возникает ошибка ввода-вывода, она может произойти после обновления данными из входного потока некоторых, но не всех байтов b. Следовательно, входной поток и b могут оказаться в несогласованном состоянии. Настоятельно рекомендуется незамедлительно закрыть поток при возникновении ошибки ввода-вывода.

public long skip(long n) throws IOException

Пропускает и отбрасывает n байтов данных из этого входного потока. По разным причинам метод skip может пропустить меньшее количество байтов, возможно, 0. Это может быть вызвано различными условиями; достижение конца файла до пропуска n байтов — лишь одна из возможных причин. Возвращается фактическое количество пропущенных байтов. Если n отрицательно, метод skip класса InputStream всегда возвращает 0, и байты не пропускаются. Подклассы могут обрабатывать отрицательное значение иначе.

public void skipNBytes(long n) throws IOException

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

Этот метод блокирует выполнение до тех пор, пока не будет пропущено запрошенное количество байтов, не будет достигнут конец файла или не будет выброшено исключение.

Если конец потока достигнут до перехода потока в требуемую позицию, выбрасывается EOFException.

Если возникает ошибка ввода-вывода, входной поток может оказаться в несогласованном состоянии. Настоятельно рекомендуется незамедлительно закрыть поток при возникновении ошибки ввода-вывода.

public int available() throws IOException

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

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

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

public void close() throws IOException

Закрывает этот входной поток и освобождает все системные ресурсы, связанные с ним.

public void mark(int readlimit)

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

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

Общее соглашение для mark состоит в том, что, если метод markSupported возвращает true, поток каким-либо образом запоминает все байты, считанные после вызова mark, и готов снова предоставить те же байты, если и когда будет вызван метод reset. Однако поток не обязан запоминать какие-либо данные, если до вызова reset из него было считано больше readlimit байтов.

Установка отметки в закрытом потоке не должна влиять на поток.

public void reset() throws IOException

Перемещает этот поток в позицию, в которой находился входной поток на момент последнего вызова метода mark.

Общее соглашение для reset таково:

• Если метод markSupported возвращает true, то:
  • Если метод mark не вызывался после создания потока или количество байтов, считанных из потока с момента последнего вызова mark, превышает аргумент, переданный в mark при этом последнем вызове, может быть выброшено IOException.
  • Если такое IOException не выброшено, поток переводится в состояние, при котором все байты, считанные после последнего вызова mark (или с начала файла, если mark не вызывался), будут повторно предоставлены последующим вызывающим метода read, а за ними последуют любые байты, которые в противном случае были бы следующими входными данными на момент вызова reset.
• Если метод markSupported возвращает false, то:
  • Вызов reset может выбросить IOException.
  • Если IOException не выброшено, поток переводится в фиксированное состояние, которое зависит от конкретного типа входного потока и способа его создания. Байты, которые будут предоставлены последующим вызывающим метода read, зависят от конкретного типа входного потока.

public boolean markSupported()

Проверяет, поддерживает ли этот входной поток методы mark и reset. Поддержка или отсутствие поддержки mark и reset является неизменным свойством конкретного экземпляра входного потока.

public long transferTo(OutputStream out) throws IOException

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

Этот метод может блокировать выполнение на неопределённое время при считывании из входного потока или записи в выходной поток. Поведение в случае асинхронного закрытия входного и/или выходного потока или прерывания потока выполнения во время передачи в значительной степени зависит от конкретного входного и выходного потока и поэтому не определено.

Если общее количество переданных байтов превышает Long.MAX_VALUE, возвращается Long.MAX_VALUE.

Если при считывании из входного потока или записи в выходной поток возникает ошибка ввода-вывода, она может произойти после считывания или записи части байтов. Следовательно, входной поток может не достичь конца, а один или оба потока могут оказаться в несогласованном состоянии. Настоятельно рекомендуется незамедлительно закрыть оба потока при возникновении ошибки ввода-вывода.