Класс 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. Однако поток не обязан запоминать какие-либо данные, если из потока прочитано более readlimit байтов до вызова reset.

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

public void reset() throws IOException

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

Общий контракт метода reset таков:

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

public boolean markSupported()

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

public long transferTo(OutputStream out) throws IOException

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

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

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

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