Класс PrintStream

Класс PrintStream добавляет функциональность к другому потоку вывода, а именно возможность удобного вывода представлений различных значений данных. Также предоставляются ещё две функции. В отличие от других потоков вывода, PrintStream никогда не выбрасывает IOException; вместо этого исключительные ситуации просто устанавливают внутренний флаг, который можно проверить с помощью метода checkError. При необходимости можно создать PrintStream, чтобы он автоматически сбрасывал буфер; это означает, что метод flush автоматически вызывается после записи массива байтов, вызова одного из методов println, или записи символа новой строки или байта ('\n') .

Все символы, выводимые PrintStream, преобразуются в байты с использованием кодировки символов по умолчанию платформы. Класс PrintWriter должен использоваться в ситуациях, требующих записи символов, а не байтов.

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

PrintStream

public PrintStream(OutputStream out)

Создаёт новый поток вывода. Этот поток не будет автоматически сбрасывать буфер.

Параметры:

out - Поток вывода, в который будут выводиться значения и объекты

См. также:

PrintWriter(java.io.OutputStream)

PrintStream

public PrintStream(OutputStream out,
                   boolean autoFlush)

Создаёт новый поток вывода.

Параметры:

out - Поток вывода, в который будут выводиться значения и объекты

autoFlush - Булево значение; если true, буфер вывода будет сбрасываться всякий раз, когда записывается массив байтов, вызываются методы println, или записывается символ новой строки или байт ('\n')

См. также:

PrintWriter(java.io.OutputStream, boolean)

PrintStream

public PrintStream(OutputStream out,
                   boolean autoFlush,
                   String encoding)
            throws UnsupportedEncodingException

Создаёт новый поток вывода.

Параметры:

out - Поток вывода, в который будут выводиться значения и объекты

autoFlush - Булево значение; если true, буфер вывода будет сбрасываться всякий раз, когда записывается массив байтов, вызываются методы println, или записывается символ новой строки или байт ('\n')

encoding - Имя поддерживаемой кодировки символов

Исключения:

UnsupportedEncodingException - Если указанная кодировка не поддерживается

С тех пор:

1.4

PrintStream

public PrintStream(String fileName)
            throws FileNotFoundException

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

Параметры:

fileName - Имя файла, который будет использоваться в качестве назначения для этого потока вывода. Если файл существует, он будет обнулен до нулевого размера; в противном случае будет создан новый файл. Вывод будет записан в файл и буферизован.

Исключения:

FileNotFoundException - Если указанный объект файла не обозначает существующий, доступный для записи обычный файл, и новый обычный файл с таким именем не может быть создан, или если произошла какая-либо другая ошибка при открытии или создании файла

SecurityException - Если присутствует менеджер безопасности и checkWrite(fileName) запрещает доступ к записи в файл

С тех пор:

1.5

PrintStream

public PrintStream(String fileName,
                   String csn)
            throws FileNotFoundException,
                   UnsupportedEncodingException

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

Параметры:

fileName - Имя файла, который будет использоваться в качестве назначения для этого потока вывода. Если файл существует, он будет обнулен до нулевого размера; в противном случае будет создан новый файл. Вывод будет записан в файл и буферизован.

csn - Имя поддерживаемой кодировки

Исключения:

FileNotFoundException - Если указанный объект файла не обозначает существующий, доступный для записи обычный файл, и новый обычный файл с таким именем не может быть создан, или если произошла какая-либо другая ошибка при открытии или создании файла

SecurityException - Если присутствует менеджер безопасности и checkWrite(fileName) запрещает доступ к записи в файл

UnsupportedEncodingException - Если указанная кодировка не поддерживается

С тех пор:

1.5

PrintStream

public PrintStream(File file)
            throws FileNotFoundException

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

Параметры:

file - Файл, который будет использоваться в качестве назначения для этого потока вывода. Если файл существует, он будет обнулен до нулевого размера; в противном случае будет создан новый файл. Вывод будет записан в файл и буферизован.

Исключения:

FileNotFoundException - Если указанный объект файла не обозначает существующий, доступный для записи обычный файл, и новый обычный файл с таким именем не может быть создан, или если произошла какая-либо другая ошибка при открытии или создании файла

SecurityException - Если присутствует менеджер безопасности и checkWrite(file.getPath()) запрещает доступ к записи в файл

С тех пор:

1.5

PrintStream

public PrintStream(File file,
                   String csn)
            throws FileNotFoundException,
                   UnsupportedEncodingException

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

Параметры:

file - Файл, который будет использоваться в качестве назначения для этого потока вывода. Если файл существует, он будет обнулен до нулевого размера; в противном случае будет создан новый файл. Вывод будет записан в файл и буферизован.

csn - Имя поддерживаемой кодировки

Исключения:

FileNotFoundException - Если указанный объект файла не обозначает существующий, доступный для записи обычный файл, и новый обычный файл с таким именем не может быть создан, или если произошла какая-либо другая ошибка при открытии или создании файла

SecurityException - Если присутствует менеджер безопасности и checkWrite(file.getPath()) запрещает доступ к записи в файл

UnsupportedEncodingException - Если указанная кодировка не поддерживается

С тех пор:

1.5

Методы

flush

public void flush()

Сбрасывает поток. Это делается путём записи всех буферизованных байтов вывода в базовый поток вывода, а затем сброса этого потока.

Указано в:

flush в интерфейсе Flushable

Переопределяет:

flush в классе FilterOutputStream

См. также:

OutputStream.flush()

close

public void close()

Закрывает поток. Это делается путём сброса потока и затем закрытия базового потока вывода.

Указано в:

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

Указано в:

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

Переопределяет:

close в классе FilterOutputStream

См. также:

OutputStream.close()

checkError

public boolean checkError()

Сбрасывает поток и проверяет его состояние ошибки. Внутреннее состояние ошибки устанавливается в true когда базовый поток вывода выбрасывает IOException отличную от InterruptedIOException, и при вызове метода setError. Если операция с базовым потоком вывода вызывает InterruptedIOException, то PrintStream преобразует исключение обратно в прерывание, выполняя:

Thread.currentThread().interrupt();

Возвращает:

true только в том случае, если в этом потоке произошла ошибка IOException отличная от InterruptedIOException, или был вызван метод setError

setError

protected void setError()

С тех пор:

JDK1.1

clearError

protected void clearError()

С тех пор:

1.6

write

public void write(int b)

Переопределяет:

write в классе FilterOutputStream

Параметры:

b - Байт, который необходимо записать

См. также:

print(char), println(char)

write

public void write(byte[] buf,
                  int off,
                  int len)

Переопределяет:

write в классе FilterOutputStream

Параметры:

buf - Массив байтов

off - Смещение, с которого начинать взятие байтов

len - Количество байтов для записи

См. также:

FilterOutputStream.write(int)

print

public void print(boolean b)

Выводит значение типа boolean. Строка, созданная String.valueOf(boolean), преобразуется в байты в соответствии с кодировкой символов по умолчанию платформы, и эти байты записываются точно так же, как в методе write(int).

Параметры:

b - Печатаемый boolean

print

public void print(char c)

Печатает символ. Символ преобразуется в один или несколько байтов в соответствии с кодировкой символов по умолчанию платформы, а эти байты записываются точно так же, как в методе write(int).

Параметры:

c - Печатаемый char

print

public void print(int i)

Печатает целое число. Строка, полученная с помощью String.valueOf(int) , преобразуется в байты в соответствии с кодировкой символов по умолчанию платформы, и эти байты записываются точно так же, как в методе write(int).

Параметры:

i - Печатаемое int

См. также:

Integer.toString(int)

print

public void print(long l)

Печатает длинное целое число. Строка, полученная с помощью String.valueOf(long) , преобразуется в байты в соответствии с кодировкой символов по умолчанию платформы, и эти байты записываются точно так же, как в методе write(int).

Параметры:

l - Печатаемое long

См. также:

Long.toString(long)

print

public void print(float f)

Печатает число с плавающей точкой. Строка, полученная с помощью String.valueOf(float) , преобразуется в байты в соответствии с кодировкой символов по умолчанию платформы, а эти байты записываются точно так же, как в методе write(int).

Параметры:

f - Печатаемое float

См. также:

Float.toString(float)

print

public void print(double d)

Печатает число с двойной точностью с плавающей точкой. Строка, полученная с помощью String.valueOf(double) , преобразуется в байты в соответствии с кодировкой символов по умолчанию платформы, а эти байты записываются точно так же, как в методе write(int).

Параметры:

d - Печатаемое double

См. также:

Double.toString(double)

print

public void print(char[] s)

Печатает массив символов. Символы преобразуются в байты в соответствии с кодировкой символов по умолчанию платформы, а эти байты записываются точно так же, как в методе write(int).

Параметры:

s - Массив символов для печати

Исключения:

NullPointerException - Если s равен null

print

public void print(String s)

Печатает строку. Если аргумент равен null, то печатается строка "null". В противном случае символы строки преобразуются в байты в соответствии с кодировкой символов по умолчанию платформы, а эти байты записываются точно так же, как в методе write(int).

Параметры:

s - Печатаемая String

print

public void print(Object obj)

Печатает объект. Строка, полученная с помощью метода String.valueOf(Object), преобразуется в байты в соответствии с кодировкой символов по умолчанию платформы, а эти байты записываются точно так же, как в методе write(int).

Параметры:

obj - Печатаемый Object

См. также:

Object.toString()

println

public void println()

Завершает текущую строку, написав строку разделителя строк. Строка разделителя строк определяется системной переменной line.separator, и не обязательно является одиночным символом новой строки ('\n').

println

public void println(boolean x)

Печатает булево значение и затем завершает строку. Этот метод работает так, как будто он вызывает print(boolean) и затем println().

Параметры:

x - Печатаемое boolean

println

public void println(char x)

Печатает символ и затем завершает строку. Этот метод работает так, как будто он вызывает print(char) и затем println().

Параметры:

x - Печатаемый char.

println

public void println(int x)

Печатает целое число и затем завершает строку. Этот метод работает так, как будто он вызывает print(int) и затем println().

Параметры:

x - Печатаемое int.

println

public void println(long x)

Печатает длинное целое число и затем завершает строку. Этот метод работает так, как будто он вызывает print(long) и затем println().

Параметры:

x - Печатаемое long.

println

public void println(float x)

Печатает число с плавающей точкой и затем завершает строку. Этот метод работает так, как будто он вызывает print(float) и затем println().

Параметры:

x - Печатаемое float.

println

public void println(double x)

Печатает число с двойной точностью с плавающей точкой и затем завершает строку. Этот метод работает так, как будто он вызывает print(double) и затем println().

Параметры:

x - Печатаемое double.

println

public void println(char[] x)

Печатает массив символов и затем завершает строку. Этот метод работает так, как будто он вызывает print(char[]) и затем println().

Параметры:

x - Массив символов для печати.

println

public void println(String x)

Печатает строку и затем завершает строку. Этот метод работает так, как будто он вызывает print(String) и затем println().

Параметры:

x - Печатаемая String.

println

public void println(Object x)

Печатает объект и затем завершает строку. Сначала вызывается String.valueOf(x) для получения строкового значения печатаемого объекта, а затем метод работает так, как будто он вызывает print(String) и затем println().

Параметры:

x - Печатаемый Object.

printf

public PrintStream printf(String format,
                          Object... args)

out.format(format, args)

Параметры:

format - Строка формата, как описано в Синтаксисе строки формата

args - Аргументы, на которые ссылаются спецификаторы формата в строке формата. Если аргументов больше, чем спецификаторов формата, лишние аргументы игнорируются. Количество аргументов переменное и может быть нулевым. Максимальное количество аргументов ограничено максимальным размером массива Java, как определено в Спецификации виртуальной машины Java™. Поведение с аргументом null зависит от преобразования.

Возвращает:

Этот поток вывода

Исключения:

IllegalFormatException - Если строка формата содержит неверный синтаксис, спецификатор формата, несовместимый с заданными аргументами, недостаточное количество аргументов для строки формата или другие неверные условия. Для описания всех возможных ошибок форматирования см. раздел Подробное описание спецификации класса форматировщика.

NullPointerException - Если format равен null

С:

1.5

printf

public PrintStream printf(Locale l,
                          String format,
                          Object... args)

out.format(l, format, args)

Параметры:

l - Локаль, которая применяется во время форматирования. Если l равен null, то никакая локализация не применяется.

format - Строка формата, как описано в Синтаксисе строки формата

args - Аргументы, на которые ссылаются спецификаторы формата в строке формата. Если аргументов больше, чем спецификаторов формата, лишние аргументы игнорируются. Количество аргументов переменное и может быть нулевым. Максимальное количество аргументов ограничено максимальным размером массива Java, как определено в Спецификации виртуальной машины Java™. Поведение с аргументом null зависит от преобразования.

Возвращает:

Этот поток вывода

Исключения:

IllegalFormatException - Если строка формата содержит неверный синтаксис, спецификатор формата, несовместимый с заданными аргументами, недостаточное количество аргументов для строки формата или другие неверные условия. Для описания всех возможных ошибок форматирования см. раздел Подробное описание спецификации класса форматировщика.

NullPointerException - Если format равен null

С:

1.5

format

public PrintStream format(String format,
                          Object... args)

Параметры:

format - Строка формата, как описано в Синтаксисе строк формата

args - Аргументы, на которые ссылаются спецификаторы формата в строке формата. Если аргументов больше, чем спецификаторов формата, дополнительные аргументы игнорируются. Количество аргументов переменное и может быть нулевым. Максимальное количество аргументов ограничено максимальным размером массива Java, определённым в Спецификации виртуальной машины Java™. Поведение с аргументом null зависит от преобразования.

Возвращает:

Поток вывода

Исключение:

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

NullPointerException - Если format является null

С:

1.5

format

public PrintStream format(Locale l,
                          String format,
                          Object... args)

Записывает отформатированную строку в этот поток вывода с использованием заданной строки формата и аргументов.

Параметры:

l - Локаль, применяемая при форматировании. Если l равно null, то локализация не применяется.

format - Строка формата, как описано в Синтаксисе строк формата

args - Аргументы, на которые ссылаются спецификаторы формата в строке формата. Если аргументов больше, чем спецификаторов формата, дополнительные аргументы игнорируются. Количество аргументов переменное и может быть нулевым. Максимальное количество аргументов ограничено максимальным размером массива Java, определённым в Спецификации виртуальной машины Java™. Поведение с аргументом null зависит от преобразования.

Возвращает:

Поток вывода

Исключение:

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

NullPointerException - Если format равно null

С:

1.5

append

public PrintStream append(CharSequence csq)

out.print(csq.toString())

Определено в:

append в интерфейсе Appendable

Параметры:

csq - Последовательность символов для добавления. Если csq равно null, то в этот поток вывода добавляются четыре символа "null".

Возвращает:

Поток вывода

С:

1.5

append

public PrintStream append(CharSequence csq,
                          int start,
                          int end)

out.print(csq.subSequence(start, end).toString())

Определено в:

append в интерфейсе Appendable

Параметры:

csq - Последовательность символов, из которой будет добавлена подпоследовательность. Если csq равно null, то символы будут добавлены так, как если бы csq содержало четыре символа "null".

start - Индекс первого символа в подпоследовательности

end - Индекс символа, следующего за последним символом в подпоследовательности

Возвращает:

Поток вывода

Исключение:

IndexOutOfBoundsException - Если start или end отрицательны, start больше end, или end больше csq.length()

С:

1.5

append

public PrintStream append(char c)

out.print(c)

Определено в:

append в интерфейсе Appendable

Параметры:

c - Символ (16-битное целое число) для добавления

Возвращает:

Поток вывода

С:

1.5