Класс 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.
  • Если такое исключение 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.

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